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

2024年3月23日 86次阅读 来源: Prasanta

开发规范

  1. 版本控制git

  2. 开发流程git flow

接口

请求方式url动作中文说明
GET/resources/list列表
POST/resources/create创建
GET/resources/:idretrieve详细
PUT/resources/:idupdate更新
PATCH/resources/:idpartial_update部分更新
DELETE/resources/:iddestroy删除

数据

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

  2. 返回格式统一为json

  3. 一个请求对应一个serializer

错误

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

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

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

认证

  1. jwt

  2. token

  3. oauth2

权限

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

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

日志

  1. 日志以中间件形式提供

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

文档(待完善)

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

{
  "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

服务器资源监控

待完善

    原文作者：Prasanta
    原文地址: https://segmentfault.com/a/1190000007855820
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞