基于HTTP规范协定的API接口设计规范构想

2024年1月27日 175次阅读 来源: 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
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞