web-dev-qa-db-ja.com

オフラインSwagger APIドキュメントを生成する方法は？

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

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

javaspring-mvcspring-bootswaggerspringfox
14
codeshark

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>）。

8
g00glen00b

Swaggerには、オフラインドキュメントを生成するためのツールがあります。

ツールは「 Swagger2Markup 」で、これは@ Githubにあります。

「Swagger2Markup」の出力は、swagger-uiの代替として使用でき、静的コンテンツとして提供できます。

ここに例があります

幸運を！ :)

7
Sahar Menashe

https://editor.swagger.io の「Generate Client」メニューで「HTML」または「Dynamic HTML」を試すことができます。静的ドキュメントに関する問題/フィードバックについては、 Swagger Codegen Githubリポジトリで報告してください。

editor.swagger.ioは https://generator.swagger.io を活用してコードを生成し、generator.swagger.io（Swagger Generator）はSwagger Codegenプロジェクトの一部です。

2
William Cheng

ライブSwagger HTMLを開きます。すべての操作を展開するをクリックします。次に、HTMLをPDFとして保存します。

これにより、適切なPDF APIドキュメントにすべての詳細が記載されています。

2
Goutham

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

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

1
Tobi

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

ここ は、APIの1つに関するドキュメントがあるポータルAPIの例です。

0
Jerrod Horton