怎么想springboot项目中使用swagger-spring-boot-starter

一直使用swagger,最近发现一款在swagger基础开发的api文档接口生成框架swagger-spring-boot-starter。我们先看看他生成的效果吧。


7798479-e29e0815443da1b0.png

1.加入依赖

7798479-98940fb7f61fe3ce.png

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

# 关闭 JSR

spring.swagger.validator-plugin=false

3.启动项目输入:http://localhost:8083/swagger-ui.html 会有一个登陆接口 用户密码在配置文件里配置了。

4.一些swagger有用的注释:

(1)在接口上加上这个

@ApiImplicitParams({

@ApiImplicitParam(name="domainId",value="系统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)

})

注释参数信息。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值