设置API的设计规范

华为云CodeArts API基于华为10年API治理经验,在Swagger 原生编辑器模式下,嵌入国内“先进级”的API全生命周期管理规范,支持 API 设计规范自动检查、自动纠错,可以灵活地配置每一个接口是否启用设计规范检查,助力开发者提升 API 设计质量。

那么怎么设置API的设计规范呢?

1、单击“项目设置 > 设计规范设置”,进入设计规范设置页面。

2、 单击“新增设计规范”,输入规范名称,单击“确定”,进入规则管理页面。

3、在规则管理页面,单击“是否启用”,启用规则。

4、返回设计规范设置页面,单击“启用”,启用设计规范。

5、进入接口的代码编辑模式,查看接口的规范检查结果。

①单击“API设计”。

②选择接口。

③单击接口的设计页签。

④单击“编辑”,进入接口的代码编辑模式。

⑤单击“规范性检查”。

⑥查看接口的规范检查结果。