一直使用swagger恢口,最近發(fā)現(xiàn)一款在swagger基礎(chǔ)開發(fā)的api文檔接口生成框架swagger-spring-boot-starter聂渊。我們先看看他生成的效果吧差购。
1.加入依賴
2.添加配置
spring.swagger.enabled=true
spring.swagger.security.filter-plugin=true
# 配置
spring.swagger.api-key.key-name=myToken
# 2.0.1 版本新特性 (支持可選的 Bean 驗證插件)
# 配置賬號密碼
spring.swagger.security.username=battcn
spring.swagger.security.password=battcn
spring.swagger.base-package=com.cornerstone.verification.controller
# 關(guān)閉 JSR
spring.swagger.validator-plugin=false
3.啟動項目輸入:http://localhost:8083/swagger-ui.html 會有一個登陸接口 用戶密碼在配置文件里配置了。
4.一些swagger有用的注釋:
(1)在接口上加上這個
@ApiImplicitParams({
@ApiImplicitParam(name="domainId",value="系統(tǒng)number",dataType="String",required=true),
? ? ? ? @ApiImplicitParam(name="username",value="用戶名",dataType="String",required=true),
? ? ? ? @ApiImplicitParam(name="password",value="密碼",dataType="String",required=true),
? ? ? ? @ApiImplicitParam(name="redirect",value="重定向地址",dataType="String",required=false)
})
注釋參數(shù)信息汉嗽。