四. 发布API

4.1 编辑API文档

4.2 API编排

4.3 API沙箱测试、套餐与上架

本章介绍API发布方法。平台使用Swagger文档来完成API的创建、发布等功能。其流程可以概括为:

  1. 编辑API文档

  2. API编排

  3. 测试

  4. 发布到测试环境

  5. 部署在生产环境

其中,测试到部署在生产环境三个步骤与容器化发布的类似,可以参考2.4~2.6节;本章对API文档和编排相关的操作进行说明。

4.1 编辑API文档

在编辑API文档之前,需要编辑API的基本信息。这个操作与APP的方式类似,可参考2.2节,此处不再赘述。

编辑好基本信息后,按“下一步”,进入API文档管理界面,如图:

单击“新建”可以建立一个新的API Swagger文档。Swagger编辑界面如下图:

在编辑界面可以完成的编辑操作有:

  1. 基本设置:定义发布API所需的具体信息,包括API摘要、方案、基本路径、主机、参数及标记和外部文档。

    1. 路径:定义API访问路径。路径表示这个API暴露的REST资源,包括“GET”,“POST”,“PUT”和“DELETE”等操作,用来定义API的请求消息和响应消息。

    2. 安全性定义:定义API安全性。安全性定义可控制客户机对API端点的访问。

    3. 安全性:管理API安全性。此处选择的安全性定义将应用于整个API,但可针对个别操作进行覆盖。

    4. 定义: 定义管理来自API Connect的固定的功能。

    5. 全局属性:定义可在整个API文档里引用的全局属性。全局属性管理来自API Connect的固定的功能。

4.2 API编排

在编排界面,可以完成与容器发布式APP编排类似的操作(见2.3节),通过拖拉拽方式组织API结构。

4.3 API沙箱测试、套餐与上架

编辑完毕后,单击右上角的“测试”按钮进行沙箱中测试。

API的套餐设置、上架与下架操作与APP基本相同,不再赘述。

results matching ""

    No results matching ""