Home | 简体中文 | 繁体中文 | 杂文 | Github | 知乎专栏 | Facebook | Linkedin | Youtube | 打赏(Donations) | About
知乎专栏

第 22 章 Spring boot with Swagger

目录

22.1. Spring boot with Springdoc
22.1.1. WebMvc
22.1.2. Webflux
22.1.3. Swagger UI
22.1.4. 从 SpringFox 迁移到 Swagger3 注解变化
22.2. Spring boot with knife4j
22.2.1. maven
22.2.2. Knife4jConfiguration
22.2.3. application.properties
22.3. springfox
22.3.1. Swagger3
22.3.2. Swagger2
22.3.3. @Api() 资源定义
22.3.4. @ApiIgnore 忽律接口
22.3.5. @ApiOperation()
22.3.6. @ApiResponses
22.3.7. @ApiModel 实体类

22.1. Spring boot with Springdoc

https://springdoc.org

22.1.1. WebMvc

Ui

			
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
            <version>2.3.0</version>
        </dependency>
    </dependencies>
			
			

Api

			
   <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
      <version>2.3.0</version>
   </dependency>			
			
			

22.1.2. Webflux

			
   <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-starter-webflux-ui</artifactId>
      <version>2.3.0</version>
   </dependency>			
			
			

22.1.4. 从 SpringFox 迁移到 Swagger3 注解变化

			
@Api → @Tag
@ApiIgnore → @Parameter(hidden = true) or @Operation(hidden = true) or @Hidden
@ApiImplicitParam → @Parameter
@ApiImplicitParams → @Parameters
@ApiModel → @Schema
@ApiModelProperty(hidden = true) → @Schema(accessMode = READ_ONLY)
@ApiModelProperty → @Schema
@ApiOperation(value = "foo", notes = "bar") → @Operation(summary = "foo", description = "bar")
@ApiParam → @Parameter
@ApiResponse(code = 404, message = "foo") → @ApiResponse(responseCode = "404", description = "foo")