目录
使用Swagger在Linux上管理API文档,并以以下方式实现:使用URL路径版本控制。 4🔥
这是最简单,最直接的方法。 将版本号嵌入API路径中,可以区分不同的版本。例如,/API/V1/用户
表示版本1,/API/V2/用户的用户API。代表版本2用户API。 Format):
16Paths:
/API/V1/User:
get: 🔥221
Summary: 25🔥
/API/V2/User: get:
Summary:37🔥GetUserList
39🔥(v2)使用HTTP请求Header版本控制。 46🔥
该方法自定义了HTTP请求标头以指定API版本。
52
Swagger配置示例:
5657🔥Parameters:
-🔥-61🔥66166667Header🔥header68 h]69🔥descriptionPi版本
Required:75🔥True
Type:7979🔥String80🔥877🔥Paths:87🔥Paths:🔥888🔥
/Api/api/api/perser: Summary:95🔥1103🔥#/parameter/x-api-version'104🔥
106🔥
3。 Use version control for media type
This method uses a 111℃ or 111℃ or 113
113
113
113113113113114🔥Application/vnd.myApp.v1json
118🔥Swagger配置示例:
122123124🔥
/api/api/api/api/api/api/api/aper: Summary:131🔥GetUserListConsumes:
-136137🔥Application/vnd.mmyapp.mmyapp.v1jsonsson
ion/vnd.myapp.v2json144🔥
4。 使用Swagger编辑器
SwaggerEditor是一种在线工具,可帮助您编写,验证和预览Swagger定义文件。 您可以将Swagger文件保存到GitHub或其他版本控制系统,并通过“文件”和“ Open URL”功能打开Swagger Editor文件,从而使您可以轻松地在不同版本之间切换。
5。使用API管理工具进行版本控制
有许多API管理工具(Apigee,Kong,Tyk等)支持Swagger版本控制。 这些工具使您可以将Swagger文件保存到存储库并跟踪文件更改。
6。使用OpenAPI Generator进行版本控制
您可以根据OpenAPI规范文件使用OpenAPI Generator来生成API文档和客户端库。 通过为每个版本创建不同的输出目录,您可以轻松管理API文档的不同版本。
158🔥Example command:
162🔥Java-jar openapi -generator.jar generate -i openapi.yaml -l java -o ./generated-api -apiv1 [java generator apgeneer openapi.yaml -l java -o ./ generated -api -v2
164🔥
7。 使用Springfox
如果您使用的是Springboot项目,则可以使用Springfox库集成Swagger执行版本控制。
170🔥Swagger配置示例171
174175@enableswagger2public180181🔥class🔥182class182swaggerfig🔥1843🔥swaggerfig184
184184 @beanPublicdocket190191{[194195🔥new🔥new196🔥197.select(h] .papis(h] “ com.example.controller”))。 PrivateApiInfoApiinfoAPI“)
.Description(”;我的API描述“) .version(“ 1.0”) .build(); } } } } } } }
与控制器一起使用
226@RestController@requestMapping(“/api/v1”) “ v1”)Public235🔥class236V1Controller238{// @restController@requestMapping(“/api/v2”)@apiexplorerSettings(groupName = “ V2”)
PublicClass250251🔥V2Controller{
// V2版本API
}
在Linux下可以使用API的工具来安装该项目。9🔥
上述内容来自Internet,并不代表本网站的所有视图! 关注我们:zhujipindao .com
评论前必须登录!
注册