1.swagger简介

Swagger是全球最大的API开发框架，这个框架以“开放API声明（OpenAPI Specification,OSA）”为基础，支持整个API生命周期的开发。它可以和SpringMVC整合，并且通过结合Swagger-ui组件，将controller层的方法进行可视化的展示，像方法注释，方法参数，方法返回值等都提供了相应的用户界面。用户可以在该界面对每个接口进行测试。
OSA，本身是一个规范，它是一个描述一整套API接口的json文件，包括接口的请求方式，参数，header等等信息。

2.swagger使用

• 在pom.xml中添加依赖

   <dependency>
      <groupId>com.spring4all</groupId>
        <artifactId>swagger-spring-boot-starter</artifactId>
        <version>1.8.0.RELEASE</version>
      </dependency>

-在resources下properties添加配置

#swagger配置
swagger.enabled=true
swagger.title=spring-boot-mybatis module api
swagger.description=Starter for swagger 2.x
swagger.license=Apache License, Version 2.0
swagger.licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.html
swagger.termsOfServiceUrl=https://github.com/dyc87112/spring-boot-starter-swagger
swagger.contact.name=zwx
swagger.contact.url=https://www.jianshu.com/u/0640fefbc8bf
swagger.contact.email=473290621@qq.com
swagger.base-package=com.springboot.mybatis.controller
swagger.base-path=/**
swagger.exclude-path=/error, /ops/**

• 在主应用application添加注释

@EnableSwagger2Doc

接下来可以登录网址进行测试（http://localhost:8080/swagger-ui.html

）启动主应用

image.png

可以进行测试