1. Importar dos dependencias
<!-- swagger2 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<!-- Swagger第三方ui依赖 -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.6</version>
</dependency>
Swaggeui recomienda utilizar dependencias de terceros
2. Configure swagger usando la clase de configuración de Java en el proyecto.
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
/**
* swagger公帮助我们生成按口文档
* 1:配置生成的文档信息
* 2:配置生成规则
*/
/**
* Docket封装接口文档信息
*
*/
@Bean
public Docket createRestApi(){
return new Docket(DocumentationType.SWAGGER_2) //指定文档风格
.apiInfo(apiInfo())
.select() //选择生成策略
.apis(RequestHandlerSelectors.basePackage("com.zstudyj.controller")) //选择要生成接口文档的类
.paths(PathSelectors.any())
.build();
}
/**
* 指定生成的文档中的封面信息:文档标题、 版本、作者等
* @return ApiInfo
*/
private ApiInfo apiInfo(){
return new ApiInfoBuilder()
.title("xx商城接口文档") //添加标题
.description("xx商城接口文档") //添加描述
.contact(new Contact("zxj","http:localhost:8081/doc.html","[email protected]"))
.version("v 2.0.1")
.build();
}
}
Configuración completada, interfaz de acceso.http://ip:port/doc.html
3. Descripción de la anotación Swagger
Swagger proporciona un conjunto de anotaciones que pueden proporcionar descripciones detalladas de cada interfaz.
@Api
Anotación de clase, agregue esta anotación a la clase de controlador para explicar la función de la clase de controlador
.
@ApiOperation
Anotación del método. Agregue esta anotación al método para explicar la función del método.
Efecto
@ApiImplicitParams
y@ApiImplicitParam
anotaciones de parámetros, indicando el tipo de parámetro, nombre, si es requerido, valor predeterminado, etc.
Efecto
@ApiModel
Y@ApiModelProperty
cuando los parámetros de la interfaz y los valores de retorno sean de tipo objeto, agregue anotaciones a la clase de entidad.