#author("2021-04-21T01:08:20+00:00","default:wikiadmin","wikiadmin")
-APIドキュメントの自動生成

*Swagger3でSpringBoot埋め込みで提供されるようになった [#daa1f3be]

https://qiita.com/Yoshihiro-Hirose/items/b96a0de3258481b16281

*参考ページ [#rd5cf041]

http://qiita.com/nvtomo1029/items/03f263423848a955f2bc

*URL等 [#yc1ef857]

-JSON
http://localhost:8080/v2/api-docs

-UI
http://localhost:8080/swagger-ui.html

**アノテーション [#pccda2ad]

https://github.com/swagger-api/swagger-core/wiki/Annotations-1.5.X#swaggerdefinition

-@Api(value = "/api/path", tags = "tagname", description = "testAPI")

なくても大丈夫だけど、より詳細な説明をController単位で追加できる
指定しない場合はtagsはハイフンつなぎのクラス名
descriptionはクラス名。valueは不明!

|tag|リストの左側|
|description|リストの右側|

-@ApiOperation("APIの操作内容を記述")

指定しないとメソッド名のところを指定した場合は、エンドポイント単位に説明追加


**設定 [#q8eee948]

     
 .apis(or(RequestHandlerSelectors.basePackage("com.rutake.xxx1"),RequestHandlerSelectors.basePackage("com.rutake.controller.rest"))) // 特定のパッケージに絞る。しぼらないならany()

    private Predicate<String> actuatorPath() {
        return regex("/actuator/?.*");
    }

トップ   編集 差分 履歴 添付 複製 名前変更 リロード   新規 一覧 検索 最終更新   ヘルプ   最終更新のRSS