python怎么调用api接口_偶尔的注解

大家好，又见面了，我是你们的朋友全栈君。

swagger 3 的使用

Swagger2（基于openApi3）已经在17年停止维护了，取而代之的是 sagger3（基于openApi3），而国内几乎没有 sagger3使用的文档，百度搜出来的都是swagger2的使用，这篇文章将介绍如何在 java 中使用 openApi3（swagger3）。

从 spring-fox 迁移到 springdoc

依赖变更

pom.xml 里去掉 springfox 或者 swagger 的依赖。添加springdoc-openapi-ui。

代码语言：javascript复制

   <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-ui</artifactId>
      <version>1.3.1</version>
   </dependency>

使用 swagger3 注解代替 swagger2 的（可选）

这一步是可选的，因为改动太大，故 springfox对旧版的 swagger做了兼容处理。但不知道未来会不会不兼容，这里列出如何用 swagger 3 的注解（已经在上面引入）代替 swagger 2 的 (注意修改 swagger 3 注解的包路径为io.swagger.v3.oas.annotations.)

对应关系为：

swagger2	OpenAPI 3	注解位置
@Api	@Tag(name = “接口类描述”)	Controller 类上
@ApiOperation	@Operation(summary =“接口方法描述”)	Controller 方法上
@ApiImplicitParams	@Parameters	Controller 方法上
@ApiImplicitParam	@Parameter(description=“参数描述”)	Controller 方法上 @Parameters 里
@ApiParam	@Parameter(description=“参数描述”)	Controller 方法的参数上
@ApiIgnore	@Parameter(hidden = true) 或 @Operation(hidden = true) 或 @Hidden	–
@ApiModel	@Schema	DTO类上
@ApiModelProperty	@Schema	DTO属性上

Swagger2 的注解命名以易用性切入，全是 Api 开头，在培养出使用者依赖注解的习惯后，Swagger 3将注解名称规范化，工程化。

修改Api 分组（当且仅当你之前定义了多个 Docket Bean）

旧：

代码语言：javascript复制

   @Bean
public Docket publicApi() { 

return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("org.github.springshop.web.public"))
.paths(PathSelectors.regex("/public.*"))
.build()
.groupName("springshop-public")
.apiInfo(apiInfo());
}
@Bean
public Docket adminApi() { 

return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("org.github.springshop.web.admin"))
.paths(PathSelectors.regex("/admin.*"))
.build()
.groupName("springshop-admin")
.apiInfo(apiInfo());
}

新：

代码语言：javascript复制

   @Bean
public GroupedOpenApi publicApi() { 

return GroupedOpenApi.builder()
.setGroup("springshop-public")
.pathsToMatch("/public/**")
.build();
}
@Bean
public GroupedOpenApi adminApi() { 

return GroupedOpenApi.builder()
.setGroup("springshop-admin")
.pathsToMatch("/admin/**")
.build();
}

如果之前只有一个 Docket，则把他删了，用配置文件替代它

代码语言：javascript复制

springdoc.packagesToScan=package1, package2
springdoc.pathsToMatch=/v1, /api/balance/**

其他情况

swagger ui在代理的后面，如 nginx

参见这篇 https://springdoc.org/faq.html#how-can-i-deploy-the-doploy-springdoc-openapi-ui-behind-a-reverse-proxy.

自定义 Swagger UI

https://springdoc.org/faq.html#how-can-i-configure-swagger-ui.

在文档中隐藏某个接口或者 Controller

https://springdoc.org/faq.html#how-can-i-hide-an-operation-or-a-controller-from-documentation-.

发布者：全栈程序员-用户IM，转载请注明出处：https://javaforall.cn/213538.html原文链接：https://javaforall.cn

spring https 网络安全 springboot html

0 人点赞

python怎么调用api接口_偶尔的注解

swagger 3 的使用

相关介绍

Open API

Swagger

SpringFox

SpringDoc

从 spring-fox 迁移到 springdoc

依赖变更

修改Api 分组（当且仅当你之前定义了多个 Docket Bean）

其他情况

swagger ui在代理的后面，如 nginx

自定义 Swagger UI

在文档中隐藏某个接口或者 Controller