详解如何在SpringBoot里使用SwaggerUI

swagger

swagger是一种和语言无关的规范和框架，用于定义服务接口，主要用于描述restful的api。它专注于为api创建优秀的文档和客户端库。支持swagger的api可以为api方法生成交互式的文档，让用户可以通过以可视化的方式试验，查看请求和响应、头文件和返回代码，从而发现api的功能。

swagger用于定义api文档。

好处：

1. 前后端分离开发
2. api文档非常明确
3. 测试的时候不需要再使用url输入浏览器的方式来访问controller
4. 传统的输入url的测试方式对于post请求的传参比较麻烦（当然，可以使用postman这样的浏览器插件）
5. spring-boot与swagger的集比较成简单

springboot嵌入swaggerui

步骤

1.jar包引入

<dependency>
  <groupid>io.springfox</groupid>
  <artifactid>springfox-swagger-ui</artifactid>
  <version>2.2.2</version>
  <scope>compile</scope>
</dependency>
<dependency>
  <groupid>io.springfox</groupid>
  <artifactid>springfox-swagger2</artifactid>
  <version>2.2.2</version>
  <scope>compile</scope>
</dependency>

2.基于springboot配置swaggerconfig

@configuration
@enableswagger2
public class swaggerconfig {
  @bean
  public docket newsapi() {
    //return new docket(documentationtype.swagger_2).apiinfo(apiinfo()).select().paths(pathselectors.any()).build();
    docket docket = new docket(documentationtype.swagger_2);
    docket.enable(true);
    docket.apiinfo(apiinfo()).select().paths(pathselectors.any()).build();
    return docket;
  }

  private apiinfo apiinfo() {
    return new apiinfobuilder().title("订单中心测试平台").description("在这里你可以浏览项目所有接口，并提供相关测试工具")
        .termsofserviceurl("http://www-03.ibm.com/software/sla/sladb.nsf/sla/bm?open").contact("test")
        .license("china red star licence version 1.0").licenseurl("#").version("1.0").build();
  }
}

3.webconfig配置说明

这里有一个需要注意的问题，让webconfig去继承webmvcautoconfigurationadapter而不是直接继承webmvcconfigureradapter，否则swagger的页面出不来。

@configuration
@enablewebmvc
public class webconfig extends webmvcautoconfigurationadapter {

  @override
  public void addcorsmappings(corsregistry registry) {
    registry.addmapping("/**");
  }

  @bean
  public static propertysourcesplaceholderconfigurer propertysourcesplaceholderconfigurer() {
    return new propertysourcesplaceholderconfigurer();
  }

  @bean
  public filter characterencodingfilter() {
    characterencodingfilter characterencodingfilter = new characterencodingfilter();
    characterencodingfilter.setencoding("utf-8");
    characterencodingfilter.setforceencoding(true);
    return characterencodingfilter;
  }

  @bean
  public mappingjackson2httpmessageconverter converter() {
    mappingjackson2httpmessageconverter converter = new mappingjackson2httpmessageconverter();
    return converter;
  }

  @bean
  public viewresolver getviewresolver() {
    internalresourceviewresolver resolver = new internalresourceviewresolver();
    resolver.setviewclass(jstlview.class);
    resolver.setprefix("/jsp");
    resolver.setsuffix(".jsp");
    return resolver;
  }

  @bean
  public standardservletmultipartresolver getstandardservletmultipartresolver() {
    return new standardservletmultipartresolver();
  }
}

4.swaggerui页面访问

http://localhost:8080/projectname/swagger-ui.html#!/

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。