接口文档检查点

原创已于 2022-04-03 21:59:58 修改 · 143 阅读

CC 4.0 BY-SA版权

文章标签：

于 2019-08-17 12:02:47 首次发布

6 篇文章

订阅专栏

本文详细介绍了API设计的基本规范，包括接口名称、描述、请求方式、编码、URL、参数及其类型，以及输出参数的正常和异常情况。深入解析了每个部分的重要性，为开发者提供全面的API设计指南。

 接口名称、接口描述

请求方式
入参编码
请求头信息要求（json/字符串/混合表单/其他的）
请求url

输入参数
参数名称
参数描述（包含字段含义、字段长度、入参值代表什么意思）
入参类型
是否必填

入参样例

输出参数（正常和异常）

 参数名称  
 参数描述 （包含字段含义、字段长度、出参值代表什么意思） 
 出参类型  
 是否为空

输出样例（正常和异常）