配置API(OpenAPI)
OpenAPI 是一个广泛使用的规范,用于描述和文档化 RESTful API。最初被称为 Swagger,OpenAPI 规范(OpenAPI Specification, OAS)提供了一种结构化的方式来定义 API 的接口,包括它的端点、操作、请求、响应以及其他相关的元数据。OpenAPI 旨在使 API 的设计、开发、文档生成和测试变得更简单、更一致。
APIPark支持 OpenAPI V2.0、V3.0 格式,可以上传 OpenAPI YAML 文件创建 API 文档。
在服务内配置的API文档在发布后,将会在服务广场中展示,如下图:
操作步骤
- 选择需要配置的服务,进入服务内页。
- 点击
API
,进入API页面。
- 点击
打开编辑器
- 在编辑器中编写OpenAPI文档。
编写完后,点击保存。