Apicurio-studio: エディターでAsyncAPI標準をサポートできる

AsyncAPI用のApicurioビジュアルエディタが欲しいです。 現在、このプロジェクトには、そのような取り組みのためのエンジニアリング帯域幅がありません。 :(

@EricWittmannご回答ありがとう

AsyncAPIのサポートを追加するのは大変な作業だと思います。 最初のタスクは、おそらくそのためのパーサー/モデルレイヤーを実装することです。 OAIの場合、ここでそれを行いました。

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

したがって、ここから始めるのがよいでしょう。おそらく、 asyncapi-ts-coreような新しいリポジトリです。

あなたがそのようなことをしているなら、それは素晴らしいことです！ Apicurioの残りの部分にasyncapiサポートを導入するための最良の方法について考え始める必要があります。 さまざまなUIページにわたっていくつかの考慮事項があります。

その価値のために、AsyncAPIはいくつかの追加の蒸気を拾い始めています。 そのため、Apicurioでサポートを提供することは、優先順位のリストを上っています。 :) ETAやそのようなものはまだありませんが、うまくいけば、この分野である程度の進歩を遂げることができます。

このニュースを聞いてうれしいです、

FWIW、 AsyncAPI2.0.0用の

それは興味深いです、 @ fmvilas-ポインタをありがとう。 実際には、AsyncAPIとOpenAPI用の独自の統合データモデル実装をここで構築しました： https ：

そのライブラリはJavaで記述され、Typescriptにトランスパイルされるため、バックエンドとUIの両方で直接使用できます。 また、完全な訪問者サポート、単純な操作変換エンジンなど、さまざまな機能があります。

コメントのより興味深い部分、つまりApicurioでAsyncAPIを使用するために実行する必要のあるタスクについて説明します。 :) :)今の大きなことは、おそらくエディターのサポートだと思います。 最終的には、ビジュアルOpenAPIエディター（検証と同時編集のサポートを含む）と同等の機能が必要です。 ただし、短期的には、既存のテキストベースのAsyncAPIエディターをApicurioに統合することで（おそらく一時的に）良い貢献ができると思います。 それはとてもクールで、大いに役立つでしょう。 テキストベースのエディタとビジュアルエディタの両方がサポートされているオプションである未来を見ることができました。 私は実際に1人のコミュニティユーザーにそれを求めてきました-彼らの上級開発者はビジュアルエディタが好きではなく、代わりにテキストエディタを望んでいました。 図に行きます。

エディター以外に、タスクのリストについて考える必要があります。 しかし、他のすべてはエディターの上にインクリメンタルになります（プロジェクトの生成など）。

コメントのより興味深い部分、つまりApicurioでAsyncAPIを使用するために実行する必要のあるタスクについて説明します。 :) :)

私はあなたを聞く ：）

さて、あなたが言ったように、簡単で簡単なものから始めましょう。 コラボレーションできる帯域幅ができ次第、お知らせします。 ありがとう！

確かに、コラボレーションは素晴らしいでしょう。 それまでの間、AsyncAPIエディターを他のアプリケーションに埋め込む方法に関するドキュメントがあれば、POCとして興味深いものをすぐにノックアウトできるでしょう。

私はここの遊び場にあるエディターを参照しています： https ：

まだ調べていません。他のアプリケーションで簡単に利用できるように構築されているかどうかはわかりませんが、そうであれば、インポートして使用するのは難しくありません。 これは、Apicurio Studio内で（少なくとも初期の）AsyncAPIサポートを要求するのに大いに役立ちます。

こんにちは@EricWittmann 、

私は今日、AsyncAPI用のグラフィカルエディタを追加するコストを調査することに時間を費やし、最近結果の始まりに到達しました。 以下のスクリーンショットを参照してください-OpenAPIと同じ構造を再作成し、既存のコードエディターを追加したので、現在の機能と同等の機能をすでに備えています。 以前に追加したAsyncAPIの例から始めました。

私が共有したいいくつかの考えや質問：

• 実装側の1番目：新しいエディターコンポーネントはすでに存在しており、既存のコンポーネントを対応するAsyncApi*複製することで、これに従うことを追求しています。 ほとんどの場合、 OasDocumentをAaiDocumentに置き換えるだけですが、それはそれほどエレガントではありません...しかし、私は表面を引っかいただけで、2つの仕様の間にもっと重要な違いがあります...この方法を維持し、2つの独立したコンポーネントのセットを使用するか、コードにif document.isOpenApi()またはif document.isAsyncApi()たくさんある場合でも、相互に接続しようとしますか？ どう思いますか ？

• プロセスの2番目。 あなたが前に言ったように、それは大きな努力かもしれません...技術的に難しいことではありませんが、長くて細心の注意を払っています...だから私は忍耐力がなく、何かをコミットする前にスペックエディタ全体を実装することは不可能だと思います。 むしろ、優先度の高いもの（ Channels 、 DataTypes 、 Messages 、 Examples ;- ））次に、優先度を低くします（ Servers 、 Traitsなど...）。 どう思いますか ？ 多くのプルリクエストで実装を分割しても大丈夫ですか？

MicrocksがAsyncAPIモック（および数週間でのテスト）をサポートするようになったことをご存知かもしれませんが、私は本当に喜んでお手伝いします。 したがって、Apicurioがそれをサポートし、最新のAPI仕様の主要なスタイルをカバーできるようにすることは、ゲームチェンジャーになる可能性があります。

cc @fmvilas ;-)

まず第一に-MicrocksにAsyncAPIサポートが追加されたことをおめでとうございます！ 最近追加されたのを見ました。

私はこれについていくつか考えています。 まず、技術的に「簡単」な場合は、AsyncAPIPlaygroundエディターをApicurioStudioに埋め込んでみるのが理にかなっていると思います。 :)それはすぐに成功し、ApicurioStudioでAsyncAPIドキュメントを編集するための合理的な「ベータ」サポートを提供します。

その後、ビジュアルエディタの作成に集中できます。

（1）実装についての質問ですが、コンポーネントを複製し、AsyncAPIに合うように変更することは、短期的には正しいアプローチだと思います。 その理由は、後でリファクタリングして2つのエディター間でコンポーネントを共有するのは簡単ですが、それ以上に、ある時点でReactでStudioUI全体を再実装する予定です。 そのため、現在のAngularの実装で行った主要な作業は無駄になります。 とにかく後でやり直す必要があるので、何かを速くする方が良いです。

（2）努力は技術的に難しいことではなく、長く細心の注意を払っていることに同意します。 :)実装を複数のPRに分割することは理にかなっていると思います。うまくいけば、複数の貢献者にまたがって作業を分割することができます。

@fmvilasエディターはAsyncAPIPlaygroundオープンソースにあり（私はそうだと思います）、Apicurio Studioなどの他のツールに簡単に統合することもできますか？

（はいの場合、ハウツードキュメントへのポインタは素晴らしいでしょう）

ありがとう@EricWittmann ！

最初にAsyncAPIプレイグラウンドをざっと見てみましたが、NodeJSにサーバー側のコンポーネントがあるようです。 だから私は統合はそれほど簡単ではないと思っていました...それが私がエディターの方法を探求する理由です;-)

週末までにもう少し時間をかけることができるはずです...よろしければ、来週の初めに最初のPRを提出してみます。 主な情報（ Version 、 Contact 、 License 、 Tags ）と、 Channels読み取り専用プレビューを編集できるようにする必要があります。左側の列の

これはオープンソースであり、ここで見つけることができます。 ただし、オートコンプリート、間違った行や列に「下線を引く」ことによってエディター自体に報告されるエラーなど、はるかに優れたものに取り組んでいます。これは実際にはAsyncAPI Hubで見られるもので置き換わります。 これはまだオープンソースではありませんが、年末までに間もなくリリースされる予定です。Reactでは、 Monacoエディター（VS Codeを強化する

ただし、Apicurio StudioでAngularを使用していることを考えると、それが役立つかどうかはわかりません。 ReactとAngularを組み合わせることが可能だと聞きましたが、正直なところ試したことはありません。

@fmvilasに感謝し

他の人がそれを埋め込むことに興味があるとは思っていませんでしたが、すでに分離されたコンポーネントであるため、簡単に埋め込むことができるはずです。そう、簡単に埋め込むことができます。 Monacoはサーバー側のレンダリングをサポートしていないため、コンポーネントは純粋にクライアント側のReactです。

途中でエディターをブートストラップするための最初のPR！ ＃1280を参照

そして、ここにもう1つ＃1285があります;-)

間もなく、デフォルトでAsyncAPIサポートを有効にする必要があります（この機能は現在、デフォルトでオフになっていると思います）。

こんにちは@EricWittmannとすべて！

これがもう1つあります：Operation、Message、OperationTrait、MessageTraitのサポート。 ＃1313を参照;-)

各概念のすべての詳細は、まだ完全にグラフィック形式として実装されていませんが、フレームワークはそこにあります。

こんにちは、みんな！

今週の終わりにいくつかの新しい拡張機能が見つかりました。別のPR＃1382があります。

これで、新しい操作を作成し、ペイロードとヘッダーのタイプを設定し、例を提供できます（Microcksコネクタを使用してAsyncAPIを直接モックできるようになったので便利です😉）

@EricWittmannどのようにそれを有効にしますか？

apicurio-studio-uiコンテナーの場合、 APICURIO_UI_FEATURE_ASYNCAPI環境変数を"true" （ブール値ではなく文字列として） @ alizard0に設定する必要があります。