Swagger 文档化 - 基于 REST 的 API
如何使用 REST API
端点可通过 /v3/swagger/editor.spr URL 进行访问，无需任何身份验证。
 |
• 自 Codebeamer 22.04 版本起，API 端点在编辑器中按字母顺序排序。
• 您需要 api_permission，才能使用 REST API 端点。
|
使用 Swagger API
打开内置 API 测试器的 <site url>/v3/swagger/editor.spr URL。
|
单击 Authorize，并输入用户名和密码。使用任何 API 端点都需要进行身份验证。
完成身份验证后，可以使用所有 API 端点。
|
 |
|
单击组名称，查看可用的 API 端点。
|
 |
|
单击 Try it out，执行 API 请求。
|
 |
|
设置跟踪器项的 ID，然后单击 Execute。
|
 |
|
执行完成后，除了响应之外，还会显示请求的 Curl 示例。
|
 |
|
如果跟踪器项的 ID 无效，响应中将返回 404 错误代码和错误消息。
|
 |
|
此外，还提供有关复杂 API 请求的示例。
|
 |
生成 Swagger 客户端
检查 Codebeamer GitHub 存储库
要将 Swagger 客户端生成的代码集成到构建进程中，可以检查 Codebeamer GitHub 存储库：https://github.com/intland/swagger-client-bootstrap。
以下 maven 模块可供使用：
◦ 生成客户端代码。
◦ 进行身份验证。
◦ 创建跟踪器项。
◦ 创建报告。
◦ 在状态之间移动跟踪器项。
在 SwaggerHub 上注册
在 SwaggerHub 上注册并导入 swagger.json 文件。请使用 /v3/swagger.json 进行下载。
使用 openapi-generator-cli
最新的生成器可通过访问 https://github.com/openapitools/openapi-generator 来获得。
以下命令基于 swagger.json 文件生成 Java 客户端。请使用 /api-docs/v3.json 进行下载。
"required": true/false 特性可能会导致代码生成器将大多数 requestBody 参数放置在所生成方法签名中的其他位置。
创建 config.json 文件，并在其中包含 {"dateLibrary":"joda"}。
运行以下命令：
java -jar openapi-generator-cli-3.3.4.jar generate -i swagger.json -g java -c config.json -o <OUTPUT directory> --api-package <package name> --artifact-id=<artifact id>