【文件属性】:
文件名称:standards.api:使徒API标准
文件大小:5KB
文件格式:ZIP
更新时间:2021-05-25 14:21:42
使徒API标准
指导方针
本文档提供了有关Apostle API的准则和示例,以鼓励一致性,可维护性和最佳实践。
资料来源
JSON API
所有端点必须遵循。
仅限JSON
Apostle API必须仅接受JSON。
参考: :
一般准则
URL标识资源。
网址只能使用名词,不能使用动词。
为了保持一致,请仅使用复数名词。
使用HTTP动词(GET,POST,PUT,DELETE)对资源进行操作。
不要嵌套资源-它会强制执行可能改变的关系并使客户端更难编写。 使用过滤/messages?connection=xyz而不是/connections/xyz/messages
API版本应表示为变更日志中记录的日期。版本号不应位于url中。
API应该位于子域之后: api.apostle.nl
RESTful URL
好的网址示例
连接清单获取https://api.a
【文件预览】:
standards.api-master
----README.md(12KB)