本文共 4947 字，大约阅读时间需要 16 分钟。

Swagger ���������������������������

Swagger ������������������������ API ������������������������������������������������������ API ������������������������������������������������������������������������������������������������������ Swagger ������������������

Swagger ���������

Swagger ������������

1. ������������

��� Spring Boot ��������������� Swagger ���������������������������������������������������������������

   
    
    
    
    
        
     
      org.springframework.boot
     
        
     
      spring-boot-starter-web
     
    
    
    
    
    
    
    
        
     
      io.springfox
     
        
     
      springfox-swagger2
     
        
     
      2.9.2
     
    
    
    
    
        
     
      io.springfox
     
        
     
      springfox-swagger-ui
     
        
     
      2.9.2
     
    
    
   

2. ������ Swagger ���������

������������ SwaggerConfig ������������ Swagger ���OCK���������

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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo());
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("My API")  // API ������������
                .description("API ������������")   // ������������
                .termsOfServiceUrl("http://example.com") // ������������ URL
                .contact("Swagger ������")    // ���������������
                .version("1.0.0")     // API ������
                .build();
    }
}

3. ������ Swagger ������

��� application.properties ��������������� Swagger UI���

# ��� Swagger ������������UI
springdoc.enabled=true

4. ���������������

������ Swagger ������������������������������������������������

.doks().select()
    .apis(RequestHandlerSelectors.no������Package("com.example"))

���������������������"

ForeverNet defined for method linkDiscoverers

������������������������

Parameter 0 of method linkDiscoverers in org.springframework.hateoas.config.HateoasConfiguration required a single bean, but 15 were found:

������������ Swagger ��� Spring Boot ������������������������������������������������������������������ Swagger ��������� Spring Boot ������������������

������������

��������������� Swagger ���������������������

package com.example Swagger;
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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.example"))
            .paths(PathSelectors.any())
            .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
            .title("������ API ������")
            .description("������������������������ Spring Boot ��� RESTful API ������")
            .termsOfServiceUrl("http://example.com")
            .contact("Swagger ������")
            .version("1.0.0")
            .build();
    }
}

������������

��������������������������� pom.xml���

   
    
    
    
    
        
     
      org.springframework.boot
     
        
     
      spring-boot-starter-web
     
    
    
    
    
    
    
        
     
      io.springfox
     
        
     
      springfox-swagger2
     
        
     
      2.9.2
     
    
    
    
    
        
     
      io.springfox
     
        
     
      springfox-swagger-ui
     
        
     
      2.9.2
     
    
    
   

��������������������� Swagger UI ������ API���

������ http://localhost:8080/swagger-ui.html

Swagger ������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������ Spring Boot������������������ API ���������