17

スプリング ブート MVC Java Web アプリがあります。API ドキュメント用に Springfox を統合することができました。サーバーが稼働しているときは、すべての API を視覚的に確認できます。

OFFLINE Swagger API ドキュメントを生成するにはどうすればよいですか? 注: asciidoc またはマークダウン ドキュメントは使用したくありませんが、html ファイルで同じ swagger API ユーザー インターフェイスを使用したいと考えています。リンクがローカルホストサーバーリンクではなくローカルディレクトリに関連するようにしたいと思います。ありがとう

4

6 に答える 6

9

Springfox を使用すると、Spring アノテーションに基づいて Swagger テスター/API ドキュメントを簡単に作成できます。

Swagger 自体には、オフライン/静的ドキュメントを生成できるツールがいくつかあります。

  • Swagger Editorには、 Generate Clientメニューにリストされているドキュメントを生成する方法がいくつかあります。
  • Swagger Codegenモジュールを使用すると、静的および動的な HTML ドキュメントを生成できます

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

于 2016-01-25T13:05:41.050 に答える
4

You can try "HTML" or "Dynamic HTML" under the "Generate Client" menu in https://editor.swagger.io. For any issue/feedback with the static doc, please report in the Swagger Codegen Github repo.

editor.swagger.io leverages https://generator.swagger.io to generate code and generator.swagger.io (Swagger Generator) is part of the Swagger Codegen project.

于 2016-01-25T08:10:40.783 に答える
2

Pretty-swag は、Swagger Specification V2 の UI であり、静的な HTML やその他の形式を生成できます。Swagger Editor に触発されています。

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

于 2017-03-26T17:06:32.543 に答える