公众号 商城 网站开发,找工作求职,推广平台排行榜app,数据分析师就业前景如何引言
后端开发中常用的接口调用工具一般使用Postman、ApiPost工具#xff0c;但后期需要与前端联调#xff0c;要补充接口文档花费大量时间#xff0c;此时Swagger3应运而生#xff0c;大大提高沟通交流的效率。
引用依赖
!-- Swagger3 调用方式 http://ip:port/swa…引言
后端开发中常用的接口调用工具一般使用Postman、ApiPost工具但后期需要与前端联调要补充接口文档花费大量时间此时Swagger3应运而生大大提高沟通交流的效率。
引用依赖
!-- Swagger3 调用方式 http://ip:port/swagger-ui/index.html --
dependencygroupIdorg.springdoc/groupIdartifactIdspringdoc-openapi-starter-webmvc-ui/artifactId
/dependency常用注解
注解标注位置作用TagController类标识Controller作用Parameter参数标识参数作用Parameters参数参数多重说明Schemamodel层的JavaBean描述模型的作用及每个属性Operation方法描述方法作用ApiResponse方法描述响应状态码
举例说明常用注解的使用
RestController
Tag(name 支付微服务模块, description 支付基本功能)
public class PayController{ResourcePayService payService;PostMapping(value /pay/add)Operation(summary 新增, description 新增支付记录)public String addPay(RequestBody Pay pay){System.out.println(pay.toString());int i payService.add(pay);return 成功插入记录返回值i;}
}含分组迭代的config配置类
import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import org.springdoc.core.models.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;Configuration
public class Swagger3Config {Beanpublic GroupedOpenApi PayApi() {return GroupedOpenApi.builder().group(支付微服务模块).pathsToMatch(/pay/**).build();}Beanpublic GroupedOpenApi OtherApi() {return GroupedOpenApi.builder().group(其它微服务模块).pathsToMatch(/other/**, /others).build();}/*Beanpublic GroupedOpenApi CustomerApi(){return GroupedOpenApi.builder().group(客户微服务模块).pathsToMatch(/customer/**, /customers).build();}*/Beanpublic OpenAPI docsOpenApi() {return new OpenAPI().info(new Info().title(Baize-Cloud-2024).description(后端通用设计).version(v1.0)).externalDocs(new ExternalDocumentation().description(www.baize.com).url(https://yiyan.baidu.com/));}
}Swagger3使用
项目启动后访问链接 ** http://localhost:8001/swagger-ui/index.html **
