St. Regis Takeaway Notes - Lecture 10 Swagger

I. Introduction

With Swagger, you only need to define interfaces and interface-related information according to its specifications, and then through a series of projects and tools derived from Swagger, you can generate interface documents in various formats, as well as online interface debugging pagesand many more.

Official website: https://swagger.io/

knife4j is an enhanced solution to generate Api documentation for Java MVC framework integration with Swagger.

Second, how to use

1. Import the maven coordinates of knife4j

com.github.xiaoyminknife4j-spring-boot-starter3.0.2

2. Import knife4j related configuration classes (WebMvcConfig)

@[email protected]@[email protected] class WebMvcConfig extends WebMvcConfigurationSupport {

@Beanpublic Docket createRestApi() {// document typereturn new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.jf.controller")).paths(PathSelectors.any()).build();}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("St. Regis Takeaway").version("1.0").description("Regi takeaway interface documentation").build();}

3. Set static resources (addResourceHandlers method in WebMvcConfig), otherwise the interface documentation page cannot be accessed

registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");

4. Set the request path that does not need to be processed in LoginCheckFilter

"/doc.html","/webjars/**","/swagger-resources","/v2/api-docs"

Three, Swagger common annotations

Notes	Description
@Api	Used on the requested class, such as Controller, to indicate the description of the class
@ApiModel	Used on a class, usually an entity class, representing a message that returns response data
@ApiModelProperty	Used on properties to describe the properties of the response class
@ApiOperation	Used in the requested method, explaining the purpose and function of the method
@ApilmplicitParams	Used in the method of the request, indicating a set of parameter description
@ApilmplicitParam	Used in the @ApilmplicitParams annotation to specify aspects of a request parameter