Question

程序员怎样规范编写接口文档

Answer 1

对于接口文档的编写规范，个人推荐直接使用eolinker，其接口文档全面，ls涉及的文档基本信息都可以通过可视化界面进行编写，不是一般的方便，同时其支持自动生成文档，支持Mock数据，自动化测试，生成SDK，团队协作等等。eolinker也是目前国内最大的在线接口管理平台~

Answer 2

接口名：参数，等注解，
附带接口案例：如何使用，
最后展示请求后成功后返回数据格式，及错误时的提示信息