このプロジェクトを見つけましたhttps://github.com/OAI/OpenAPI-Specification
私が理解したように、ドキュメントを.json/.ymlファイルに書くことができます。また、http://editor.swagger.io/で、ファイルにレンダリングできることがわかり.htmlます。
私の質問は、ファイル.htmlから静的ページを生成するにはどうすればよいですか? .json/.ymlスプリング ブート アプリケーションのチュートリアルはありますか? どうにかして.json/.ymlファイルをswagger構成に設定し.html、ドキュメント付きのファイルを取得する必要がありますか?
.ymlまたは.jsonファイルから HTML、JavaScript、および CSS アセットのコレクションを生成する必要はありません。Swagger UIを実行しているサーバーに YAML/JSON ファイルを渡すだけで、Swagger UI はそれらの Swagger 準拠 API から美しいドキュメントを動的に生成します。ペットショップの例でアイデアが得られるはずです。
Jenkins のようなビルド エンジン (CI/CD サーバーなど) を使用して、ドキュメントの公開プロセスを自動化できます。たとえば、各 REST API リポジトリは、これら.ymlまたは.jsonファイルの少なくとも 1 つを提供する必要があります (ちなみに、これらは Swagger エディターによって生成されます)。次に、そのリポジトリにプッシュするたびに、Jenkins はそれら.ymlまたは.jsonファイルを取得し、Swagger UI が稼働しているドキュメント サーバーにアップロードします。
.ymlREST API 開発者は、API ドキュメント リンクをクライアント開発者と共有でき、または.jsonファイルの各変更がドキュメントに反映されることを確信できます。変更をプッシュするだけです。これらの Swagger 準拠の API を維持する必要があるため、個人的にはこのファイルを使用することをお勧めし.ymlます。単純に、このファイルの方が読みやすいからです。