API服务文档

API服务文档是客户端了解API功能的重要方式,一份完善的API文档可以节省大量的运维支撑工作。

网关控制台中允许API提供商为API编写多篇说明文档。

原则上要求所有API在发布前都必须编写API服务文档

编写服务文档

API管理>我的API>选中一个API>文档管理菜单下:

点击编写文档或添加文档,就可以开始编写API服务文档:

这里编写服务文档采用Markdown语法。

编写完成后点击保存即可。

编写多篇服务文档

如果需要编写多篇服务文档,只需要保存好一份之后继续添加即可。

这里我们添加了两篇文档。

发布到服务目录后,客户端开发者就能看到这两篇服务文档了。

上一篇:API服务接口 下一篇:API权限定义