写好接口文档的方法

来源：懂视网责编：小采时间：2020-11-27 15:26:38

写好接口文档的方法:本文主要和大家分享如何写好接口文档的方法，希望能帮助大家写好一个接口文档。1 HTTP携带信息的方式urlheadersbody: 包括请求体，响应体2 分离通用信息一般来说，headers里的信息都是通用的，可以提前说明，作为默认参数3 路径中的参数表达式URL中参数表

推荐度：

点击下载本文 文档为doc格式

导读写好接口文档的方法:本文主要和大家分享如何写好接口文档的方法，希望能帮助大家写好一个接口文档。1 HTTP携带信息的方式urlheadersbody: 包括请求体，响应体2 分离通用信息一般来说，headers里的信息都是通用的，可以提前说明，作为默认参数3 路径中的参数表达式URL中参数表

一些文档里可能会加入字段的类型，但是我认为这是没必要的。以为HTTP传输的数据往往都需要序列化，大部分数据类型都是字符串。一些特殊的类型，例如枚举类型的字符串，可以在说明里描述。

另外：数据模型非常建议使用表格来表现。

举个栗子

声明：本网页内容旨在传播知识，若有侵权等问题请及时与本网联系，我们将在第一时间删除处理。TEL:177 7030 7066 E-MAIL:11247931@qq.com

推荐度：

点击下载本文 文档为doc格式

标签：文档方法写的