Project learning-framework learning-Swagger3

< dependency > < groupId > io.springfox </groupId > < artifactId > springfox-swagger2 </artifactId > < version > 3.0.0 </version > </dependency >

< dependency > < groupId > io.springfox </groupId > < artifactId > springfox-swagger-ui </artifactId > < version > 3.0.0 </version > </dependency >

< Dependency > < the groupId > io.springfox </the groupId > < the artifactId > springfox-Boot-Starter </the artifactId > < Version > 3.0.0 </Version > </dependency > copy the code

@EnableOpenApi //Only need to start the application class configuration in Application @SpringBootApplication public class Swagger3Application { public static void main (String[] args) { SpringApplication.run(Swagger3Application.class, args); } } Copy code

import org.apache.commons.lang3.reflect.FieldUtils; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.util.ReflectionUtils; import org.springframework.web .servlet.config.annotation.InterceptorRegistration; import org.springframework.web.servlet.config.annotation.InterceptorRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; import springfox.documentation.builders.ApiInfoBuilder; import springfox .documentation.builders.PathSelectors; importspringfox.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 java.lang.reflect.Field; import java.util.List;

@Configuration public class Swagger3Config implements WebMvcConfigurer { @Bean public Docket createRestApi () { return new Docket(DocumentationType.OAS_30) .apiInfo(apiInfo()) .select() //Through the .select() method, to configure the scanning interface, RequestHandlerSelectors configure how to scan the interface /* basePackage(final String basePackage)//scan the interface according to the package path any()//Scan all, all interfaces in the project will be scanned none()//do not scan the interface //Scan through annotations on methods, such as withMethodAnnotation(GetMapping.class) only scan get requests withMethodAnnotation(final Class<? extends Annotation> annotation) //Scan through annotations on the class, such as .withClassAnnotation(Controller.class) only scans interfaces in classes with controller annotations withClassAnnotation(final Class<? extends Annotation> annotation) */ .apis(RequestHandlerSelectors.basePackage( "com.study.swagger3.controller" )) //basePackage scans the interface according to the package path /* any()//scan any request none()//Do not scan any request regex(final String pathRegex)//control by regular expression ant(final String antPattern)//control by ant() */ .paths(PathSelectors.any()) //Configure how to filter by path, that is, scan all requests here any none ant regex .build(); }

/** * The top half of the API page displays information */ private ApiInfo apiInfo () { return new ApiInfoBuilder() .title( "Swagger3 Interface Document" ) .description( "document description" ) .contact( new Contact( "hughJin" , "#" , "[email protected]" )) .version( "1.0" ) .build(); }

/** * Universal interceptor excludes swagger settings, all interceptors will automatically add swagger-related resource exclusion information */ @Override public void addInterceptors (InterceptorRegistry registry) { try { Field registrationsField = FieldUtils.getField(InterceptorRegistry.class, "registrations" , true ); List<InterceptorRegistration> registrations = (List<InterceptorRegistration>) ReflectionUtils.getField(registrationsField, registry); if (registrations != null ) { for (InterceptorRegistration interceptorRegistration: registrations) { interceptorRegistration .excludePathPatterns( "/swagger**/**" ) .excludePathPatterns( "/webjars/**" ) .excludePathPatterns( "/v3/**" ) .excludePathPatterns( "/doc.html" ); } } } catch (Exception e) { e.printStackTrace(); } } } Copy code

import com.study.swagger3.dto.User; import io.swagger.annotations.Api; import io.swagger.annotations.ApiImplicitParam; import io.swagger.annotations.ApiOperation; import io.swagger.annotations.ApiParam; import org. springframework.web.bind.annotation.*; import springfox.documentation.annotations.ApiIgnore;

@Api(value = "@Api: Used on the controller class to indicate the description of the class", tags = "Swagger test user information management API") @RestController @RequestMapping("/user") public class SwaggerController {

@ApiIgnore //Ignore this API @GetMapping("/hello") public String hello () { return "hello" ; }

@GetMapping(value = "/swaggerGet/{name}") @ApiOperation(value = "Interface method description", notes = "@ApiOperation: used on the requested method to explain the purpose and function of the method") @ApiImplicitParam(name = "name", value = "@ApiImplicitParams: used in the request method to indicate a set of parameter descriptions", required = true, dataType = "String", paramType = "path") public String swaggerGet ( @PathVariable String name) { return "name=" +name; }

@PostMapping(value = "/swaggerPost") @ApiOperation(value = "Add user", notes = "@ApiOperation Swagger test RESTful POST request test input a POJO (JSON format)") public User swaggerGet ( @RequestBody User user) { return user; }

@GetMapping(value = "/swaggerApiParam") @ApiOperation(value = "test parameter") public User swaggerApiParam ( @ApiParam(value = "primary key query" ,required = true) String id) { return new User(); }

}

//////////////////////////////////////

import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty;

import java.io.Serializable;

@ApiModel("Entity class@ApiModel: used on the response class (POJO entity class), describing a return response data information (description of the entity description of the POJO class request or response)") public class User implements Serializable {

private static final long serialVersionUID = -6627165976923138391L ;

@ApiModelProperty(value = "Username@ApiModelProperty: Used on POJO properties to describe the property description of the response class", dataType = "String", name = "username", example = "hughJin") private String username; @ApiModelProperty( value = "Account password", dataType = "String", name = "password", example = "123456") private String password;

public String getUsername () { return username; }

public void setUsername (String username) { this .username = username; }

public String getPassword () { return password; }

public void setPassword (String password) { this .password = password; }

@Override public String toString () { return "User{" + "username='" + username + '\'' + ", password='" + password + '\'' + '}' ; } } Copy code

<!--Knife4j--> <!-- https://mvnrepository.com/artifact/com.github.xiaoymin/knife4j-spring-boot-starter --> < dependency > < groupId > com.github.xiaoymin </groupId > < artifactId > knife4j-spring-boot-starter </artifactId > < version > 3.0.2 </version > </dependency > < dependency > < groupId > com.github.xiaoymin </groupId > <artifactId >springdoc-ui-knife4j </artifactId > <-! Please, in applying the maven central repository search 3.X latest version -> < Version > 3.0.2 </Version > </dependency > Copy the code

/doc.html#/home