http-api-design:HTTP设计准则

时间:2024-05-02 23:17:10
【文件属性】:

文件名称:http-api-design:HTTP设计准则

文件大小:7KB

文件格式:ZIP

更新时间:2024-05-02 23:17:10

HTTP API设计标准 指导方针 本文档提供了GoCardless API的准则和示例,以鼓励一致性,可维护性和最佳实践。 资料来源: JSON API 所有端点必须遵循核心 对JSON API的更改: 主资源必须通过其资源类型进行键控。 端点URL还必须与资源类型匹配。 API错误当前不遵循JSON API规范。 更新应始终以完整资源返回200 OK ,以简化内部逻辑。 按类型键入资源的示例: GET /posts/ 1 { " posts " : { " id " : 1 } } 仅JSON 该API仅应支持JSON。 参考: : 一般准则 URL标识资源。 网址应包含名词,而不是动词。 为了保持一致性,仅使用复数名词(例如,“ posts”而不是“ post”)。 使用HTTP动词( GET , POST , PUT , DELET


【文件预览】:
http-api-design-master
----LICENSE(1KB)
----.gitignore(10B)
----README.md(15KB)

网友评论