spring cloud / spring boot 专题Java 开发

怎么在springboot项目中使用swagger-spring

2018-11-01  本文已影响1049人  小生不cai

一直使用swagger,最近发现一款在swagger基础开发的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

# 关闭 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)

})

注释参数信息。

上一篇 下一篇

猜你喜欢

热点阅读