URL路径
返回结果
GET /teachers 返回资源列表
GET /teachers/:id 返回单独的资源
POST /teachers 返回新生成的资源对象
PUT /teachers/:id 返回完整的资源对象
PATCH /teachers/:id 返回被修改的属性
DELETE /teachers/:id 返回一个空文档
返回状态码推荐标准HTTP状态码
举例来说,有一个API提供学校的信息,包括各个班级,老师,同学的信息,则它的路径应该设计成下面这样:
URI语法
如果只需要查询某些条件的数据API应该提供参数,过滤返回结果。下面是一些常见的参数:
?limit=10:指定返回记录的数量
?offset=10:指定返回记录的开始位置。
?page=2&per_page=100:指定第几页,以及每页的记录数。
?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序。
?teacher_subject=语文:指定筛选条件
REST是一种软件架构风格,如果你的股票交易官方接口,接口是REST股票交易官方接口,接口,那么该股票交易官方接口,接口可被认为是REST风格的。REST股票交易官方接口,接口是围绕资源展开的,HTTP的URL即资源,利用HTTP的协议,其实rest本也可以和HTTP无关,但是现在大家普遍的使用REST都是依托于HTTP协议。
URL规则1名词对应数据库中的表2URL中不能有动词3URL结尾不应该包含斜杠“/”4正斜杠分隔符”/“必须用来指示层级关系5使用连字符”-“来提高URL的可读性,而不是使用下划线”_”6URL路径中首选小写字母7URL路径名词均为复数
URI=scheme“://”authority“/”path[“?”query][“#”fragment]
scheme: 指底层用的协议,如http、https、ftp
host: 服务器的IP地址或者域名
port: 端口,http中默认80
path: 访问资源的路径,就是咱们各种web 框架中定义的route路由
query: 为发送给服务器的参数
fragment: 锚点,定位到页面的资源,锚点为资源id
HTTP动词
资源过滤
对于URL资源的具体操作类型,由HTTP动词表示。常用的HTTP动词有下面五个。
GET(SELECT):从服务器取出资源(一项或多项)。
POST(CREATE):在服务器新建一个资源。
PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。
PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性)。
DELETE(DELETE):从服务器删除资源。
返回
路径又称'终点',表示API的具体网址。在RESTful架构中,每个网址代表一种资源,所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的'集合',所以API中的名词也应该使用复数。
文章为作者独立观点,不代表股票交易接口观点