2016-01-25 10 views
10

私は春の起動MVC Java Webアプリケーションを持っています。私はAPIドキュメントのためにSpringfoxを統合することができました。サーバーが稼動しているときにすべてのAPIを視覚的に見ることができます。オフラインSwagger APIドキュメントを生成するには?

どうすればオフラインスワッガーAPIドキュメントを生成できますか?注:私はasciidocやmarkdownのドキュメントを使用したくないですが、htmlファイルにも同じようなAPIユーザーインターフェイスが必要です。私はリンクがローカルホストサーバーのリンクの代わりにローカルディレクトリに相対的であるようにしたいと思います。おかげ

答えて

2

あなたがhttps://editor.swagger.ioで「クライアントを生成」メニューの下に「HTML」または「ダイナミックHTML」を試すことができます。静的ドキュメントに関する問題やフィードバックについては、Swagger CodegenGithubレポをご報告ください。

editor.swagger.ioはコードを生成するためにhttps://generator.swagger.ioを使用し、generator.swagger.io(Swagger Generator)はSwagger Codegenプロジェクトの一部です。

5

Springfoxは、あなたが簡単にあなたの春の注釈に基づいて闊歩テスター/ APIのドキュメントを作成することができます。

闊歩自体は、オフライン/静的なドキュメントを生成できるようにするいくつかのツールを持っている:

  • Swagger Editorに記載されて生成するドキュメントのいくつかの方法がありますSwagger Codegenモジュールは、あなたがすることを可能にするクライアントメニュー
  • を生成します静的で動的なHTML文書を生成する

どちらもSwagger YAMLまたはJSONファイルが必要です。 Springfoxを使用しているため、YAML/JSONでSwagger定義がない場合は、Swagger UI(/v2/api-docs?group=<group name>)に使用されている生成ファイルを使用できます。

1

https://www.DynamicApis.comをご覧ください。 APIポータルを作成し、派手なJSONドキュメントをアップロードすることができます。このサイトでは、Swaggerドキュメントを使用して、かなりクールなツールと一緒に、API用のより優れたユーザーインターフェイスを生成しています。

Hereは彼らのAPIのいずれかのドキュメントを持つポータルAPIの一例です。

4

スワガーにはオフラインドキュメントを生成するツールがあります。

ツールはGithubの@に配置され、 "Swagger2Markup" です。

「Swagger2Markup」の出力は、闊歩-UIを代替として使用することができ、静的コンテンツとして配信することができます。

Here is an Example

幸運! :)

0

プリティ盗品は、他の形式の静的HTMLを生成することができる闊歩仕様V2のためのUIです。これはSwagger Editorからインスピレーションを受けています。

チェックアウトhttps://github.com/twskj/pretty-swag

関連する問題