基于HTTP标准协议的API接口设计规范构思

warmcheng 发布于2019-08-21 11:18 / 1678人阅读

摘要：开发规范版本控制开发流程接口请求方式动作中文说明列表创建详细更新部分更新删除数据请求支持返回格式统一为一个请求对应一个错误错误信息包含在返回内容里不同的错误对应不同的错误信息代码错误码按照标准用法使用认证权限以中间件形式作为权限鉴别

开发规范

版本控制git

开发流程git flow

接口

请求方式	url	动作	中文说明
GET	/resources/	list	列表
POST	/resources/	create	创建
GET	/resources/:id	retrieve	详细
PUT	/resources/:id	update	更新
PATCH	/resources/:id	partial_update	部分更新
DELETE	/resources/:id	destroy	删除

数据

请求支持form-date,json,x-www-form-urlencode

返回格式统一为json

一个请求对应一个serializer

错误

错误信息包含在返回内容里

不同的错误对应不同的错误信息代码

http错误码按照标准用法使用

认证

jwt

token

oauth2

权限

以中间件形式作为权限鉴别插件，根据http请求格式直接判断权限

用户登录成功时，将用户信息与权限信息缓存保证效率

日志

日志以中间件形式提供

根据业务需求氛围入库日志与普通日志

文档(待完善)

根据上面的接口格式写文档

{
  "resources": {
    "list": {
      "params": {},
      "response": {}
    },
    "create": {
      "request": {},
      "response": {}
    },
    "retrieve": {
      "response": {}
    },
    "update": {
      "request": {},
      "response": {}
    },
    "partial_update": {
      "request": {},
      "response": {}
    },
    "destroy": {}
  }
}

测试

业务所需接口测试覆盖率100%

部署

docker

docker-compose

docker-machine

docker-swarm

服务器资源监控

待完善

专线服务服务器托管分布式云服务器的设计构思 api接口规范标准api服务接口 api接口设计

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/86552.html

基于HTTP标准协议的API接口设计规范构思

摘要：开发规范版本控制开发流程接口请求方式动作中文说明列表创建详细更新部分更新删除数据请求支持返回格式统一为一个请求对应一个错误错误信息包含在返回内容里不同的错误对应不同的错误信息代码错误码按照标准用法使用认证权限以中间件形式作为权限鉴别开发规范版本控制git 开发流程git flow 接口请求方式 url 动作中文说明 GET /resources/ list 列表 ...

gghyoo 2019-07-25 11:14 评论0 收藏0
全栈开发自学路线

摘要：前言这里筑梦师是一名正在努力学习的开发工程师目前致力于全栈方向的学习希望可以和大家一起交流技术共同进步用简书记录下自己的学习历程个人学习方法分享本文目录更新说明目录学习方法学习态度全栈开发学习路线很长知识拓展很长在这里收取很多人的建议以后决前言这里筑梦师,是一名正在努力学习的iOS开发工程师,目前致力于全栈方向的学习,希望可以和大家一起交流技术,共同进步,用简书记录下自己的学习历程...

galaxy_robot 2019-06-28 18:47 评论0 收藏0
全栈开发自学路线

摘要：前言这里筑梦师是一名正在努力学习的开发工程师目前致力于全栈方向的学习希望可以和大家一起交流技术共同进步用简书记录下自己的学习历程个人学习方法分享本文目录更新说明目录学习方法学习态度全栈开发学习路线很长知识拓展很长在这里收取很多人的建议以后决前言这里筑梦师,是一名正在努力学习的iOS开发工程师,目前致力于全栈方向的学习,希望可以和大家一起交流技术,共同进步,用简书记录下自己的学习历程...

Scorpion 2019-08-22 16:34 评论0 收藏0