当前位置: 首页 > 后端技术 > Node.js

基于HTTP标准协议的API接口设计规范概念

时间:2023-04-03 23:31:10 Node.js

开发规范版本控制git开发流程git流接口请求方法urlaction中文描述resources/:idupdateupdatePATCH/resources/:idpartial_updatepartialupdateDELETE/resources/:iddestroydelete数据请求支持form-date、json、x-www-form-urlencode返回格式统一为json一个请求对应一个serializererrorerrormessagecontains在返回的内容中,不同的错误对应不同的错误信息码。http错误码按照标准用法使用中间件形式的认证jwttokenoauth2权限作为权限认证插件。当权限用户根据http请求格式成功登录后,直接判断用户信息和权限信息。缓存保证效率。日志以中间件的形式提供。根据业务需要,日志和普通日志文档(待完善)按照上述接口格式编写{"resources":{"list":{"params":{},"response":{}},"创建”:{“请求”:{},“响应”:{}},“检索”:{“响应”:{}},“更新”:{“请求”:{},“响应”:{}},"partial_update":{"request":{},"response":{}},"destroy":{}}}测试服务所需的接口测试覆盖率100%部署dockerdocker-composeddocker-machinedocker-swarm服务器资源监控待改进