接口文档规范总结学习

接口规范（RESTful API规范： ）

URL: 不含大写，uri地址里不允许出现大写字母，如果是两个单词拼接，用/分开

资源集合

在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。

例如：
https://api.jupiter.com/v1.1/animals
https://api.jupiter.com/v1.1/employees

返回参数结构

三部分：状态码+状态码描述+数据（单数据或者集合）

• 状态码：status: 0
• 数据：data: {} || []
• 描述：msg: ‘’

例如：
{
	status: 0,
	data: {} || [],
	msg: ''
}