本章节讲述企业内部如何开放API及文档。企业内部之间通过ROMA API将服务或数据变现,内部之间相互调用实现资源共享。
例如,部门A在ROMA API开放API,设计API、生成产品并上架到API目录,部门B通过API目录查看和订阅API。此时,部门A通过开放业务能力,使自身服务能力变现,部门B直接订阅部门A开放的API,减少开发时间和成本,实现部门之间业务共享。
开放API
A部门将自己的业务变现。
- 将A部门的业务生成设计文档。
在“API设计”页面,选择“创建API设计 > 导入Swagger文件”,导入本地API文档。如需通过其他方式创建API设计文档,请参考《用户指南》。
- 将设计文档封装成API服务。
- 在“编辑器”页面,单击“导入到API服务”,规则检查通过后,继续导入。
- 在“导入API设计文件”页面,选择实例并编辑服务名称。
- 进入“全局配置(可选)”页面,并发布。
- 将API服务生成产品。
在“API运行”页面,单击“生成产品”。
- 将API产品上架API目录。
- 进入产品详情页面,提交上架申请。
图1 提交上架申请
- 在“审核管理”页面,选择“我提交的申请”页签,可查看申请详情。
- 在“审核管理”页面,选择“我审核的申请”页签,单击“查看详情”,审批产品信息。
图2 审批申请
- 查看上架是否成功。
返回产品详情页面,查看版本是否上架成功。
图3 上架成功
查看API产品
B部门在“目录列表”中查看API产品。
订阅API
B部门在“目录列表”中订阅API产品。
- 单击“订阅”,填写订阅申请信息。
图4 订阅申请
- 在“审核管理”页面,选择“我提交的申请”页签,可查看申请详情。
- 在“审核管理”页面,选择“我审核的申请”页签,单击“查看详情”,审批订阅信息。
图5 审批申请
- 订阅成功后,B部门可以调用A部门的API。
订阅成功后,可以在“订阅与凭证”中查看该凭证下已经订阅成功的产品,也可以取消订阅产品。
图6 订阅成功
- (可选)返回目录列表,单击产品名称,选择版本号进入,可查看已开放的API以及进行调试。