問題タブ [springdoc]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
java - Springdoc を使用して OpenAPI ドキュメントからエンドポイントを非表示にする方法
Springdoc は、すべてのハンドラー メソッドの API ドキュメントを自動的に生成します。OpenAPI アノテーションがなくても。
API ドキュメントからエンドポイントを非表示にするにはどうすればよいですか?
swagger - Springdoc OpenAPI ui は、「場所」のコンテキストパスを尊重しません
設定:
springdoc-openapi-ui
シンプルなスプリングブートプロジェクトでカスタマイズせずに、バージョン 1.4.0 (Maven 経由)の Java ライブラリを使用しています。
Swagger ページは https://my-url.com/my-context-path/swagger-ui/index.htmlの下に生成されます
https://my-url.com/my-context-path/v3/api-docs/の下の api-docs
これらは両方とも機能し、私はそれらに到達できます。ここまでは順調ですね!
今問題:
https://my-url.com/my-context-path/swagger-ui.htmlに移動するだけで、HTTP ステータス 302 とlocation
、swagger ページにリダイレクトするはずの応答ヘッダーに設定された属性を取得しています。上から(だと思います)。
ただし、location
属性の URL にはコンテキスト パスがありません。次のようになります:
https://my-url.com/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config
存在しないページにリダイレクトされ、404 エラー コードが表示されます。configUrl にもコンテキストパスがないように見えることに注意してください。
なぜこれが発生し、どのように修正できるのでしょうか?
この Github Issue は同じ問題のように見えましたが、最終的には問題が修正されたと述べられています: https://github.com/springdoc/springdoc-openapi/issues/37であり、それは私のものよりも前のバージョンのものです。
openapi - springdoc の API リファレンス ドキュメントはどこにありますか?
Java ライブラリは、Open API 3 を Spring プロジェクト (の代替) と統合するためのspringdoc-openapi
まともなライブラリですspringfox
。
私はリファレンスドキュメントを探していました(このようなspringfox
); 公式サイトしか見つかりませんでした。そのウェブサイトはライブラリの使用法をよく説明していますが、完全な API リファレンスではありません。
また、適切なチュートリアルがいくつかあります: Baeldung、DZone、Piotrminkowski Blog。しかし、整理された API リファレンス ドキュメントはありません。
良い参考書はありますか?