接口文档没有固定的样式,只要把相关的信息显示出来就可以
例如:
- 接口名称
- 接口说明
- 接口地址
- 请求参数
- 返回参数
- 错误码(一般大批量的接口都使用统一的错误码来返回)
下面是本人使用过的接口文档样式
这是腾讯官方的接口文档
版权声明:本文来源CSDN,感谢博主原创文章,遵循 CC 4.0 by-sa 版权协议,转载请附上原文出处链接和本声明。
原文链接:https://blog.csdn.net/qq_36219549/article/details/96473588
站方申明:本站部分内容来自社区用户分享,若涉及侵权,请联系站方删除。
-
发表于 2019-09-05 16:25:59
- 阅读 ( 1337 )
- 分类: