Springdoc

913 ワード

Swagger UI


Swager UIを使用してAPI Documentを表示することが多い.
Springプロジェクトで最も一般的な2つのライブラリはspring-foxspringdoc-openapi-uiです.spring-foxを応用した経験がありましたが、現在推奨されているのはspringdocなので、springdocを試してみたいと思います.

優先パラメータの設定


第一に、build.gradleを修正する必要があります.
dependencies {
	... 

	// Springdoc
	implementation 'org.springdoc:springdoc-openapi-ui:1.5.10'
以下のパスを設定してアクセスすると、写真のようにSwager UI画面を表示できます.
[server address]/swagger-ui.html

Reference


https://springdoc.org/#getting-started