项目接口文档
my-blog
一、先定义所有接口,返回的参数规范。
结构体:
{
"status": 0,
"msg": {},
"errmsg": ""
}
参数类型:
status:int,状态码,0表示正常,1表示错误
msg:object,消息体
errmsg:string,错误提示信息
二、规划请求 URL与对应的请求方式(GET/POST/RESOURCE/...)
METHOD | URL |
---|---|
GET | example.com?name=? |
POST | example.com |
三、根据具体的业务功能需求,规划每个接口用到的参数。
参数设置:
命名规范要统一,如:单词之间使用下划线,或小驼峰等;
名字要避免使用多义词,如:customer(client);
数据表的字段命名规范与设计;
....