Apicurio-studio: 편집기에서 AsyncAPI 표준 지원 가능

AsyncAPI용 Apicurio 비주얼 편집기를 보고 싶습니다. 현재 이 프로젝트에는 그러한 노력을 위한 엔지니어링 대역폭이 없습니다. :(

@EricWittmann 답변 감사합니다. 그렇게 어렵지 않다면 이 기능에 대한 작업을 위해 시간을 찾도록 노력하겠습니다...

AsyncAPI에 대한 지원을 추가하는 것은 엄청난 양의 작업이라고 생각합니다. 첫 번째 작업은 아마도 이를 위한 파서/모델 레이어를 구현하는 것입니다. OAI의 경우 여기에서 수행했습니다.

https://github.com/apicurio/oai-ts-core

아마도 asyncapi-ts-core 와 같은 새로운 저장소일 것입니다.

당신이 그런 종류의 일을 하고 있다면 그것은 훌륭할 것입니다! Apicurio의 나머지 부분에 asyncapi 지원을 가져오는 가장 좋은 방법에 대해 생각하기 시작해야 합니다. 다양한 UI 페이지에는 여러 가지 고려 사항이 있습니다.

그만한 가치가 있기 때문에 AsyncAPI는 몇 가지 추가 기능을 확보하기 시작했습니다. 따라서 Apicurio에서 지원을 제공하는 것이 우선 순위 목록에 올라 있습니다. :) 아직 ETA 또는 이와 유사한 것은 없습니다. 하지만 이 영역에서 약간의 진전을 시작할 수 있기를 바랍니다.

@EricWittmann , 감사합니다. 시간이 충분하다면 참여하고 싶습니다.

FWIW, 이제 AsyncAPI 2.0.0용 파서가 있습니다. Typescript로의 마이그레이션에 대해 논의했습니다. Apicurio에서 AsyncAPI를 사용하기 위해 수행해야 하는 작업 목록이 있으면 좋을 것입니다. 도와드릴 수 있습니다 :)

흥미 롭네요 , https://github.com/Apicurio/apicurio-data-models

이 라이브러리는 Java로 작성되었으며 Typescript로 변환되어 백엔드와 UI에서 직접 사용할 수 있습니다. 또한 전체 방문자 지원, 간단한 운영 변환 엔진 등과 같은 다양한 기능을 갖추고 있습니다.

귀하의 의견 중 더 흥미로운 부분인 Apicurio에서 AsyncAPI를 사용하기 위해 수행해야 하는 작업입니다. :) :) 지금 가장 중요한 것은 아마도 편집자 지원일 것입니다. 궁극적으로 저는 시각적 OpenAPI 편집기(검증 및 동시 편집 지원 포함)와 기능 패리티를 갖고 싶습니다. 그러나 단기적으로 (아마도 일시적인) 좋은 기여는 기존 텍스트 기반 AsyncAPI 편집기를 Apicurio에 통합하는 것이라고 생각합니다. 그것은 매우 멋지고 먼 길을 갈 것입니다. 텍스트 기반 편집기와 비주얼 편집기가 모두 지원되는 미래를 볼 수 있습니다. 실제로 한 커뮤니티 사용자가 요청한 적이 있습니다. 수석 개발자는 시각적 편집기를 좋아하지 않고 대신 텍스트 편집기를 원했습니다. 그림을 이동.

편집자 외에는 작업 목록을 생각해야 합니다. 그러나 다른 모든 것은 편집기 위에서 증분됩니다(예: 프로젝트 생성).

귀하의 의견 중 더 흥미로운 부분인 Apicurio에서 AsyncAPI를 사용하기 위해 수행해야 하는 작업입니다. :) :)

듣고 있어요 :)

글쎄, 당신이 말했듯이 쉽고 / 더 쉬운 것부터 시작합시다. 협업할 수 있는 대역폭이 확보되는 대로 알려 드리겠습니다. 감사 해요!

협력은 확실히 굉장할 것입니다. 그 동안 AsyncAPI 편집기를 다른 응용 프로그램에 포함하는 방법에 대한 문서가 있는 경우 POC로 흥미로운 것을 매우 빨리 녹아웃시킬 수 있습니다.

여기 놀이터에서 찾을 수 있는 편집기를 참조하고 있습니다. https://playground.asyncapi.io/

나는 아직 그것에 대해 조사하지 않았으므로 다른 응용 프로그램 내에서 쉽게 활용되도록 구축되었는지 여부는 확실하지 않지만 그렇다면 가져오기 및 사용이 어렵지 않기를 바랍니다. 그것은 Apicurio Studio 내에서 (최소한 초기) AsyncAPI 지원을 요구하는 데 먼 길을 갈 것입니다.

안녕하세요 @EricWittmann ,

저는 오늘 AsyncAPI용 그래픽 편집기를 추가하는 비용이 얼마인지 조사하는 데 시간을 할애하고 최근 결과의 시작 부분에 도달했습니다. 아래 스크린샷을 참조하십시오. 저는 OpenAPI와 동일한 구조를 다시 만들고 이미 가지고 있는 코드 편집기를 추가했기 때문에 현재와 비교하여 이미 기능 패리티가 있습니다. 이전에 추가한 AsyncAPI 예제에서 시작했습니다.

공유하고 싶은 몇 가지 생각과 질문:

• 구현 측면에서 1위: 새 편집기 구성 요소가 이미 있었고 기존 구성 요소를 AsyncApi* 대응 요소로 복제하여 이를 따르고 있습니다. 대부분의 경우 OasDocument 를 AaiDocument 바꾸는 것은 그다지 우아하지 않습니다 ... 그러나 방금 표면을 긁었고 두 사양 사이에 더 중요한 차이점이 있을 것입니다 ... 코드를 따라 if document.isOpenApi() 또는 if document.isAsyncApi() 가 많더라도 이 방식을 유지하고 2개의 독립적인 구성 요소 집합을 사용하거나 상호화하려고 하시겠습니까? 어떻게 생각해 ?

• 2차 공정. 전에도 말했듯이 큰 노력이 필요할 것입니다... 기술적으로 어렵지는 않지만 길고 세심한... 그래서 나는 인내심이 없을 것이며 어떤 것을 커밋하기 전에 전체 사양 편집기를 구현하는 것이 실현 가능하지 않을 것이라고 생각합니다. 높은 우선 순위( Channels , DataTypes , Messages , Examples ;- )) 그런 다음 더 낮은 우선순위( Servers , Traits 등...)로 이동합니다. 어떻게 생각해 ? 많은 pull 요청에 대해 구현을 분할해도 괜찮습니까?

Microcks가 이제 AsyncAPI 모의(및 몇 주 내 테스트)를 지원한다는 것을 보셨을 것이므로 기꺼이 도와드리겠습니다. 따라서 Apicurio가 이를 지원하고 최신 API 사양의 주요 스타일을 다룰 수 있도록 하는 것은 게임 체인저가 될 수 있습니다.

cc @fmvilas ;-)

우선 - Microcks에 AsyncAPI 지원이 추가된 것을 축하합니다! 최근에 추가된 것을 봤습니다.

나는 이것에 대해 몇 가지 생각이 있습니다. 첫째, 기술적으로 "쉬운" 경우 AsyncAPI Playground 편집기를 Apicurio Studio에 포함시키려고 시도하고 가져오는 것이 합리적일 수 있다고 생각합니다. :) 그것은 빠른 승리가 될 것이며 Apicurio Studio에서 AsyncAPI 문서 편집을 위한 합리적인 "베타" 지원을 제공할 것입니다.

그 후에는 비주얼 편집기를 만드는 데 집중할 수 있습니다.

(1) 구현에 대한 질문에 대해 - 단기간에 구성 요소를 복제하고 AsyncAPI에 맞게 수정하는 것이 올바른 접근 방식이라고 생각합니다. 그 이유는 나중에 두 편집기 간에 구성 요소를 공유하기 위해 리팩토링하는 것이 충분히 쉽기 때문입니다. 하지만 그 이상은 어느 시점에서 React에서 전체 Studio UI를 다시 구현할 것이기 때문입니다. 따라서 현재 Angular 구현에서 우리가 하는 모든 주요 노력은 낭비됩니다. 어쨌든 나중에 다시 해야 하므로 빨리 하는 것이 좋습니다.

(2) 노력이 기술적으로 어렵지는 않지만 길고 세심하다는 데 동의합니다. :) 구현이 여러 PR로 분할되는 것이 합리적이라고 생각합니다. 여러 기여자 간에 작업을 나눌 수도 있기를 바랍니다.

@fmvilas 편집기가 AsyncAPI Playground 오픈 소스(예라고 가정함)에 있으며 Apicurio Studio와 같은 다른 도구에도 쉽게 통합될 수 있습니까?

(그렇다면 하우투 문서에 대한 포인터는 굉장할 것입니다)

@EricWittmann 감사

AsyncAPI 플레이그라운드를 먼저 간단히 살펴보았지만 NodeJS에 서버 측 구성 요소가 있는 것 같습니다. 그래서 통합이 그렇게 쉽지는 않을 거라고 생각했는데... 그래서 에디터의 길을 모색하게 되었습니다 ;-)

이번주말까지는 좀 더 시간을 할애할 수 있을텐데... 괜찮으시다면 다음주 초에 첫 PR을 해볼께요. 이 편집 가능한 주 정보를 가질 수 있어야한다 ( Version , Contact , License 및 Tags ) 역시 읽기 전용 프리뷰 Channels 왼쪽 열의

오픈 소스이며 여기에서 찾을 수 AsyncAPI Hub 에서 볼 수 있는 것이므로 결국 Playground를 대체하게 될 것입니다. 이것은 아직 오픈 소스가 아니지만 확실히 올해가 끝나기 전에 곧 있을 것이며, Monaco 편집기 (VS Code를 지원하는 편집기)를 사용하여 React에서 완료됩니다.

그러나 Apicurio Studio에서 Angular를 사용하고 있다는 점을 감안하면 도움이 될지 모르겠습니다. React와 Angular를 결합하는 것이 가능하다고 들었지만 솔직히 시도한 적이 없습니다.

@fmvilas 에게 감사드립니다. 궁극적으로 React

우리는 다른 사람들이 그것을 포함하는 데 관심이 있을 거라고는 생각하지 않았지만 이미 분리된 구성 요소이기 때문에 하기 쉬워야 하므로 쉽게 포함할 수 있도록 만들 수 있습니다. Monaco는 서버 측 렌더링을 지원하지 않기 때문에 구성 요소는 순전히 클라이언트 측 React입니다.

에디터 부트스트랩을 위한 첫 번째 PR이 진행 중입니다! #1280 참조

그리고 여기 #1285의 또 다른 것이 있습니다 ;-)

곧 기본적으로 AsyncAPI 지원을 활성화해야 합니다(이 기능은 현재 기본적으로 꺼져 있다고 생각합니다).

안녕하세요 @EricWittmann입니다 !

Operation, Message, OperationTrait 및 MessageTrait 지원을 제공하는 또 다른 기능이 있습니다. #1313 참조 ;-)

각 개념의 모든 세부 사항은 아직 그래픽 형식으로 완전히 구현되지 않았지만 프레임워크는 있습니다.

안녕하세요 여러분!

이번 주말에 새로운 기능 향상을 위해 시간을 찾았습니다. 여기 또 다른 PR #1382가 있습니다.

이제 새 작업을 만들고 페이로드 및 헤더 유형을 설정하고 예제를 제공할 수 있습니다(이제 Microcks 커넥터로 AsyncAPI를 직접 조롱할 수 있으므로 유용함

@EricWittmann 어떻게 활성화합니까?

apicurio-studio-ui 컨테이너의 경우 APICURIO_UI_FEATURE_ASYNCAPI 환경 변수를 "true" (부울이 아닌 문자열로), @alizard0 으로 설정해야 합니다.