目录
  1. 1.  首先需要集成Swagger,在项目中加入如下依赖:
  2. 2.  配置Swagger启动类
  3. 3. 访问方法
SpringBoot使用Swagger构建接口文档

 首先需要集成Swagger,在项目中加入如下依赖:

  • 建议引入2.8或以上版本
  • 本人使用Springboot+gradle
1
2
compile('io.springfox:springfox-swagger2:2.8.0')
compile('io.springfox:springfox-swagger-ui:2.8.0')

 配置Swagger启动类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
@Configuration
@EnableSwagger2
@EnableAutoConfiguration
@ComponentScan(basePackages = {"cn.server.controller","cn.server.example.controller"})//扫描不同包下的Controller生成文档
public class Swagger2 {

@Bean
public Docket createRestApi() {
//让swagger-ui支持传入token访问
ParameterBuilder ticketPar = new ParameterBuilder();
List<Parameter> pars = new ArrayList<Parameter>();
ticketPar.name("Authorization").description("token")
.modelRef(new ModelRef("string"))
.parameterType("header")
.defaultValue("Bearer ")
.required(true)
.build();
pars.add(ticketPar.build());
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
// .apis(RequestHandlerSelectors.basePackage("cn.server.controller"))默认扫描一个包下的Controller
.paths(PathSelectors.any())
.build()
.globalOperationParameters(pars);
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("接口文档")
.description("简单优雅的restfun风格")
.termsOfServiceUrl("https://www.baidu.com")
.version("1.0")
.build();
}
}

访问方法

  • localhost:8080/swagger-ui.html

上述所生成的风格为Swagge官方UI,也可以自行编辑或找寻大神所修改的SwaggeUI
更多详情参考:Swagger官网

文章作者: 今晚早睡
文章链接: https://www.chensubao.com/article/26395.html
版权声明: 本博客所有文章除特别声明外,均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来自 洛 苏り

评论