O Swagger-UI é uma coleção de HTML, Javascript, CSS, que pode gerar dinamicamente documentos de API on-line com base em anotações.
Notas comuns:
- @Api: usado para modificar a classe Controller e gerar informações de documentos relacionadas ao Controller
- @ApiOperation: usado para modificar métodos na classe Controller para gerar informações de documentos relacionadas aos métodos de interface
- @ApiParam: usado para decorar os parâmetros na interface e gerar informações do documento relacionadas aos parâmetros da interface
- @ApiModelProperty: usado para modificar as propriedades da classe de entidade, quando a classe de entidade é um parâmetro de solicitação ou retorna o resultado, gera diretamente informações relevantes do documento
(1) Adicione dependência no pom.xml
<!--Swagger-UI API文档生产工具-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>
(2) Configuração da bota de mola 2.2.5
@EnableWebMvc
@Configuration
@EnableSwagger2
@ComponentScan(basePackages = "com.wxw.controller"