3.9.10. 项目特定的 Swagger 文档

REST API 通用接口文档可以通过 http://files.cuba-platform.com/swagger/7.0 获得。

任何运行的 CUBA 应用程序还有项目特定的接口文档，文档结构按照 Swagger specification version 2.0 生成。

文档可以通过下面这些 URL 获得：

• /rest/v2/docs/swagger.yaml - YAML 版本的通用接口文档

• /rest/v2/docs/swagger.json - JSON 版本的通用接口文档

• /rest/v2/docs/swaggerDetailed.yaml - YAML 版本的项目特定 Swagger 接口文档

• /rest/v2/docs/swaggerDetailed.json - JSON 版本的项目特定 Swagger 接口文档

示例：

http://localhost:8080/app/rest/v2/docs/swagger.yaml
http://localhost:8080/app/rest/v2/docs/swaggerDetailed.yaml

接口文档可以用来查看，测试或者生成 REST API 的客户端代码。参考以下工具： Swagger UI， Swagger Inspector， Postman， Swagger Codegen。

生成的文档包括：

• CRUD 操作，比如：

• 实体 CRUD 操作：

• 获取实体实例列表

• 过滤实体

所有 CRUD 的参数和相应都有对应的模型，示例：

• 预定义的 REST 查询:

• 暴露的 services 接口: