SpringBoot integra Swagger para implementar la documentación de la interfaz en línea

SpringBoot integra Swagger para implementar la documentación de la interfaz en línea

1. Cree un proyecto SpringBoot, construya con maven.
2. Agregue las siguientes dependencias al archivo pom

	<!--swagger-->
	<dependency>
	    <groupId>io.springfox</groupId>
	    <artifactId>springfox-swagger2</artifactId>
	    <version>2.4.0</version>
	</dependency>
	<dependency>
	    <groupId>io.springfox</groupId>
	    <artifactId>springfox-swagger-ui</artifactId>
	    <version>2.4.0</version>
	</dependency>

3. Escribir una clase de configuración

@Configuration
@EnableSwagger2
public class Swagger2 {
    
    

    @Bean
    public Docket createRestApi(){
    
    
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
                .apis(RequestHandlerSelectors.basePackage("com.naihe.swagger_test.controller."))
                .paths(PathSelectors.any()).build();
    }

    private ApiInfo apiInfo(){
    
    
        return new ApiInfoBuilder()
                .title("swagger集成测试")
                .contact(new Contact("naihe", "http://www.itnaihe.club:8081", "[email protected]"))
                .description("欢迎访问接口文档,这是描述信息")
                .version("1.0").build();
    }
}

4. Utilizado en el controlador

@RestController
@RequestMapping("/details")
@Api(value = "详情相关业务接口", tags = "详情业务相关的controller")
public class DetailsController {
    
    
    @GetMapping("/getDetails")
    @ApiOperation(value = "xxx", name = "xxx")
    public String getDetails(){
    
    
        return "details";
    }
}

Anotaciones comunes y descripciones de sus funciones