rest api接口规范

1.设计规范

　　1.协议：使用HTTPs协议 确保交互数据的传输安全

　　2.域名：尽量将api部署在专用域名下https：//api.example.com

　　3.版本控制：将版本号放在url中或者header中 v1，v2，vn

　　4.路径：只能包含名词，

　　5.过滤信息：？limit=10 ？offset=10 ？page=1 ？sortby=name

　　6.Hypermedia Api：在返回结果中提供相关资源的连接，连向其他Api方法

　　7.验证：确定用户是其声明的身份，比如提供账户的密码

　　8.授权：保证用户有对资源特定操作的权限。比如用户私人信息只能自己能够访问，其他人无法看到，有些特殊的操作只能管理员可以操作，其他用户有只读的权限等

　　9.状态码：

　　　　200　　现有资源已被更改

　　　　201　　如果新资源被创建

　　　　202　　已接受处理请求但尚未完成

　　　　301　　资源的url被更新

　　　　303　　如负载均衡

　　　　400　　指用户发送的错误请求

　　　　401　　用户没有权限

　　　　403　　访问禁止

　　　　404　　资源不存在

　　　　406　　服务端不支持所需要表示

　　　　409　　通用冲突

　　　　412　　前置条件失败

　　　　415 　　接受到的表示不受支持

　　　　500　　通用错误响应

　　　　503　　服务当前无法处理请求

　　10.接口实例

 

转载于:https://www.cnblogs.com/Marcki/p/10020749.html