接口文档包含的主要内容有哪些?

发布网友 发布时间:2022-04-22 08:34

我来回答

1个回答

热心网友 时间:2022-06-18 18:00

一般一个规范的接口文档至少包含三部分信息,分别是基本信息,请求参数部分,响应部分
基本部分又包括接口名称,接口URL,请求方法以及描述信息;
请求参数部分主要包括请求头和请求体部分,主要是对这两个部分的每个字段定义的说明和解释
响应部分主要包括响应返回的数据类型,已经响应数据中每个字段的含义 。
以前在黑马程序员培训后,也会买他们出版的书,这个就是直接从书上看的。现在很多大学都用的他们的教材,我就会没事看看。反正说的挺详细的。

声明声明:本网页内容为用户发布,旨在传播知识,不代表本网认同其观点,若有侵权等问题请及时与本网联系,我们将在第一时间删除处理。E-MAIL:11247931@qq.com