管理API设计

操作步骤

1. 登录ROMA API控制台。
2. 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。
3. 在左侧导航栏单击“API设计”。
   根据下表相关任务，了解如何管理API设计文件。

   表1 管理API设计

   相关任务	使用场景	操作步骤
   导入到API服务	从API设计文件中挑选部分API接口生成API服务，开放给其他用户使用。	单击对应API设计文件所在行的“导入到API服务”。或单击“编辑器”/“表单”页面中的“导入到API服务”。 导入规则检测通过后，单击“继续导入”。 选择实例，编辑服务名称，选择API接口，单击“立即导入”。 （可选）服务全局配置具体操作步骤请参考导入API设计文件。
   重命名	修改API设计文件名称。	单击对应API设计文件所在行的“重命名”，即可修改名称。
   删除	删除API设计文件。	单击对应API设计文件所在行的“删除”，即可删除。
   API变更历史	API设计文件的变更记录。支持查看变更前后的内容和还原变更内容。	查看全局API设计文件的变更历史 在页面右上角单击“API变更历史”，进入变更列表页面。 通过变更时间、请求方式或URL筛选变更信息。 单击“查看详情”，可通过文本形式或表单形式查看变更内容。 查看单个API设计文件的变更历史 单击对应API设计文件所在行的“变更历史”，即可查看相关操作记录。 单击对应操作所在行的“查看对比”，查看变更前和变更后的对比信息。 （可选）差异对比，可任意选择两个操作，单击“差异对比”，查看变更前后的信息。 如需还原操作，单击对应操作所在行的“还原”，还原到当前版本。
   导入	API设计文件从本地导入API设计。	在页面中单击API设计文件名称，进入API编辑页面。 单击“编辑器/表单”页签。 单击，导入文件。
   导出	API设计文件以YAML或JSON格式导出到本地，用于导入API设计或其他用途。	在页面中单击API设计文件名称，进入API编辑页面。 单击“编辑器/表单”页签。 根据需要导出文件的格式，单击，选择“导出YAML/导出JSON”导出文件。
   Mock调测	对API设计文件的接口地址进行调测。	在页面中单击API设计文件名称，进入API编辑页面。 单击“编辑器”页签。 在编辑窗口上方开启“Mock”会自动生成Mock服务地址，您可以在可视化窗口对接口地址进行调测。
   规范性检查	在API设计过程中提供接口规范性检查，帮助用户快速设计标准的RESTful API。	在页面中单击API设计文件名称，进入API编辑页面。 单击“编辑器”页签。 单击编辑窗口上方的“规范性检查”。 在可视化窗口单击“Show”查看结果，您可以根据“修改建议”修改规范性问题。 （可选）单击“表单”页签。 单击页面右上角“规范性检查”。 在弹窗中查看结果，您可以根据“修改建议”修改规范性问题。
   创建Tag	对API接口进行分类处理，方便筛选或查找API接口。	在页面中单击API设计文件名称，进入API编辑页面。 单击“表单”页签。 在“API列表”区域，单击。 在弹窗中填写Tag信息后，单击“确定”。
   创建API	在API设计文件中创建多个API接口。	在页面中单击API设计文件名称，进入API编辑页面。 单击“表单”页签。 在“API列表”区域，单击或在对应Tag右侧单击。 在页面右侧对API进行可视化编辑设计。 编辑完成后，单击“保存”。