私はこのプロジェクトを見つけました 私が理解したように、.json/.ymlというファイルで文書を書くことができます。私はhttp://editor.swagger.io/にあるので、簡単にファイル.htmlにレンダリングすることができました。春のブートプロジェクトにSwagger OpenAPI仕様を追加してください。
私の質問 - これらのファイルから静的な.htmlページを生成する方法は？スプリングブートアプリケーションのチュートリアルはありますか？私はどういうわけかファイルを用意して.htmlファイルを準備する必要がありますか？
.ymlまたは.jsonファイルからHTML、JavaScript、CSSアセットのコレクションを生成する必要はありません。 Swagger UIを実行するサーバーにYAML/JSONファイルを渡すだけで、Swagger UIはSwagger準拠のAPIから美しい文書を動的に生成します。 petstoreの例を参考にしてください。
Jenkinsのようなビルドエンジン（CI/CDサーバーなど）を使用すると、ドキュメントの公開プロセスを自動化できます。たとえば、各REST APIリポジトリには、.ymlまたは.jsonファイル（スワッガーエディタで生成される）のうち少なくとも1つを指定する必要があります。その後、そのリポジトリにプッシュするたびに、.ymlまたは.jsonのファイルが取得され、Swagger UIが起動しているドキュメントサーバーにアップロードされます。
REST APIの開発者は、クライアントの開発者とAPIドキュメントのリンクを共有できますが、.ymlまたは.jsonファイルの各変更がドキュメントに反映されることも確信できます。彼らは単に変更をプッシュする必要があります。 Swaggerに準拠したAPIを維持する必要があるので、私は個人的に読むことができるので、.ymlファイルを使用することを提案します。
swagger-uiがjsonを同じディレクトリからレンダリングする可能性はありますか？たとえば、私は静的コンテンツフォルダにswagger-uiを持っていますが、swagger.jsonファイルもあります。 –
@Orestそれは可能であるはずです。あなたは 'yml'ファイルのリンクをswagger UIに渡すだけです –