0

問題:

Swagger、RAML、または API ブループリント入力の HTML 表現を生成できる Java または JavaScript (またはおそらく Scala) のライブラリを探しています。

バックグラウンド:

アイデアは、API カタログとして機能する (Play Framework) Web アプリの一部として使用することです。API 仕様は API カタログのユーザーによって追加され、結果の HTML 表現が生成/表示されます。

API 仕様スタブも Java API を使用して作成できれば、さらに価値があります。API カタログ Web アプリには、API スタブを生成するときに使用したいデータ モデルがあります。

さらに、同じ (または関連する別の) ライブラリが、編集中にユーザーをサポートする API 仕様言語 (Swagger、RAML、API Blueprint など) の優れた HTML エディターを提供する場合、追加の価値が得られます。

4

3 に答える 3

2

Swagger は、それを行うための一連のツールを提供します。

Swagger-Core を使用すると、Play コードから Swagger ドキュメントを作成できます。これは実行時に行われ、アプリケーションが変更されると変更されます。

Swagger-UI はそのようなドキュメントを読み取り、HTML 形式で表示します。また、操作を実行することもでき、必要に応じてセキュリティ メカニズムと統合できます。UI は、アプリケーションのルック アンド フィールに合わせてカスタマイズできます (これまで多くの人が行ってきたように)。

Swagger-Editor を使用すると、HTML 形式のドキュメントをインタラクティブに並べて表示して、Swagger ドキュメントを直接編集できます。

Swagger-Codegen は、このようなドキュメントを取得して、クライアント コードとサーバー コードの両方を生成できます。ニーズに合わせてテンプレートをカスタマイズできます。

于 2014-10-24T17:16:53.330 に答える
0

RAML の場合: - https://github.com/kevinrenskers/raml2html - https://github.com/mikestowe/php-raml2html

それらを試してみてください;)

于 2014-12-17T18:23:57.997 に答える
0

API ブループリントから HTML を生成するためのツールがいくつかあります。そのうちの 1 つは Coffeescript にあり、Aglio と呼ばれます。ここですべてのツールを確認できます。

http://apiblueprint.org/

また、Apiaryは API ブループリントを使用するサービスであり、生成されたドキュメントの編集とホスティング、Github との接続によるコミットからの自動生成、チームや企業向けのモック API やその他の優れた機能の提供に使用できます。API ドキュメントの堅実なサービスが必要な場合は、チェックしてみてください。

于 2014-10-24T16:29:18.633 に答える