• Restful架构


    一、网站及软件:

      网站也可以作为软件,而且是一种新型的软件。这种“互联网软件”采用客户端/服务器模式,建立在分布式体系上,通过互联网通信,具有高延时、高并发等特点。

    二、RESTful是啥?

      REST(Representational State Transfer,简称REST)(资源)表现层状态传输。在三种主流的Web服务交互方案中,REST比SOAP以及XML-RPC更加简单明了,倾向于用更加简单轻量的方法设计和实现。REST是一种设计风格。

      1、资源:网络上的一段文本、一张图片、一首歌曲、一种服务等。唯一的URI(同一资源定位符),每个资源对应特定的URI。要访问这个资源,访问它的URI既可以,URI是每个资源的地址或者独一无二的标识符。

      2、表现层:“信息实体展示出来”。我们把“资源”呈现出来的形式,叫做它的“表现层”。应该在HTTP请求的头信息用Accept和Content-Type来制定,而不是通过URI来显示它的资源形式。

      3、状态转化:HTTP协议是一个无状态协议。所有的资源都保存在服务器端。客户端想要操作资源,必须让服务器端的资源发生状态变化。这种转化是建立在表现层的基础上,所以是“表现层状态转化”。客户端的手段是HTTP协议。HTTP协议里,四个表示操作方式的动词:GET、POST、PUT、DELETE。对应四种基本操作:GET获取资源,POST用来新建资源(更新资源也可以),PUT用来更新资源,DELETE用来删除资源

    三、REST原则:

      REST原则:客户端和服务器之间的交互在请求之间是无状态。

    四、常见的误区:

      URI是资源的地址或者独一无二的标识符。标示的是资源,所以不应该含有动词。动词放在HTTP协议中的方法。

      版本信息也不应该含有版本信息。版本信息应该存放在header的Accept中

    五、Restful API设计指南:

      1、协议:API与用户的通信协议,总是使用HTTPs协议

      2、尽量将API部署在专用子域名下:https://api.example.com

        如果API很简单,不会有进一步扩展,可以考虑放在主域下

      3、API的版本可以放在URL中,也可以将其放在HTTPS头信息中

      4、路径(Endpoint):API的具体路径

        在RESTful架构中,每个网址代表一种资源。网址中不应当含有冬至,只能包含名词,而且所用名词往往与数据库的表格相对应。

        数据库的表格一般存储的都是多条数据。所以API中的名词应当使用复数

      5、HTTP请求的方法:

        常用的HTTP方法(括号里对应的是SQL命令) 

    GET(SELECT):从服务器取出资源(一项或多项)。
    POST(CREATE):在服务器新建一个资源。
    PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。
    PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性)。
    DELETE(DELETE):从服务器删除资源。

        还有两个不常用的HTTP动词

    HEAD:获取资源的元数据。
    OPTIONS:获取信息,关于资源的哪些属性是客户端可以改变的。

        实例:

    GET /zoos:列出所有动物园
    POST /zoos:新建一个动物园
    GET /zoos/ID:获取某个指定动物园的信息
    PUT /zoos/ID:更新某个指定动物园的信息(提供该动物园的全部信息)
    PATCH /zoos/ID:更新某个指定动物园的信息(提供该动物园的部分信息)
    DELETE /zoos/ID:删除某个动物园
    GET /zoos/ID/animals:列出某个指定动物园的所有动物
    DELETE /zoos/ID/animals/ID:删除某个指定动物园的指定动物

      6、信息过滤:

        API应该提供信息过滤的参数条件。可以将用户需要的数据返回给用户,而不是全部数据

        常见的过滤条件:   

    ?limit=10:指定返回记录的数量
    ?offset=10:指定返回记录的开始位置。
    ?page=2&per_page=100:指定第几页,以及每页的记录数。
    ?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序。
    ?animal_type_id=1:指定筛选条件

        参数设计可以存在冗余,即API路径和URL参数偶尔有重复

      7、部分状态码(Status COde):状态码的完全列表请点这里

    200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。
    201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。
    202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务)
    204 NO CONTENT - [DELETE]:用户删除数据成功。
    400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。
    401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。
    403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。
    404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。
    406 Not Acceptable - [GET]:用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。
    410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。
    422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。
    500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。

      8、错误处理

        如果发生错误,应以error为键,出错信息为值即可。还可以加上status_code的键值对

      9、返回结果,应当符合以下规范   

    GET /collection:返回资源对象的列表(数组)
    GET /collection/resource:返回单个资源对象
    POST /collection:返回新生成的资源对象
    PUT /collection/resource:返回完整的资源对象
    PATCH /collection/resource:返回完整的资源对象
    DELETE /collection/resource:返回一个空文档

      10、API尽量做到Hypermedia API

        返回结果提供超链接,链接向其他API方法,方便用户的使用,例如直接访问api的根路径

    {"link": {
      "rel":   "collection https://www.example.com/zoos",
      "href":  "https://api.example.com/zoos",
      "title": "List of zoos",
      "type":  "application/vnd.yourformat+json"
    }}

        例如访问github的根API:返回https://api.github.com/,返回内容如下

    {
      "current_user_url": "https://api.github.com/user",
      "current_user_authorizations_html_url": "https://github.com/settings/connections/applications{/client_id}",
      "authorizations_url": "https://api.github.com/authorizations",
      "code_search_url": "https://api.github.com/search/code?q={query}{&page,per_page,sort,order}",
      "commit_search_url": "https://api.github.com/search/commits?q={query}{&page,per_page,sort,order}",
      "emails_url": "https://api.github.com/user/emails",
      "emojis_url": "https://api.github.com/emojis",
      "events_url": "https://api.github.com/events",
      "feeds_url": "https://api.github.com/feeds",
      "followers_url": "https://api.github.com/user/followers",
      "following_url": "https://api.github.com/user/following{/target}",
      "gists_url": "https://api.github.com/gists{/gist_id}",
      "hub_url": "https://api.github.com/hub",
      "issue_search_url": "https://api.github.com/search/issues?q={query}{&page,per_page,sort,order}",
      "issues_url": "https://api.github.com/issues",
      "keys_url": "https://api.github.com/user/keys",
      "notifications_url": "https://api.github.com/notifications",
      "organization_repositories_url": "https://api.github.com/orgs/{org}/repos{?type,page,per_page,sort}",
      "organization_url": "https://api.github.com/orgs/{org}",
      "public_gists_url": "https://api.github.com/gists/public",
      "rate_limit_url": "https://api.github.com/rate_limit",
      "repository_url": "https://api.github.com/repos/{owner}/{repo}",
      "repository_search_url": "https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order}",
      "current_user_repositories_url": "https://api.github.com/user/repos{?type,page,per_page,sort}",
      "starred_url": "https://api.github.com/user/starred{/owner}{/repo}",
      "starred_gists_url": "https://api.github.com/gists/starred",
      "team_url": "https://api.github.com/teams",
      "user_url": "https://api.github.com/users/{user}",
      "user_organizations_url": "https://api.github.com/user/orgs",
      "user_repositories_url": "https://api.github.com/users/{user}/repos{?type,page,per_page,sort}",
      "user_search_url": "https://api.github.com/search/users?q={query}{&page,per_page,sort,order}"
    }

      11、其他

        (1)API的身份认证应该使用OAuth 2.0框架。

        (2)服务器返回的数据类型,使用JSON

    参考文档:http://www.ruanyifeng.com/blog/2014/05/restful_api.html

      

  • 相关阅读:
    【转】logback logback.xml常用配置详解(三) <filter>
    【转】logback logback.xml常用配置详解(二)<appender>
    【转】logback logback.xml常用配置详解(一)<configuration> and <logger>
    webhook: requestbin
    Docker: repository, image, container
    Python 知识点
    MySql: 常见sql语句
    MySql: 常见错误
    Linux 网络命令必知必会之 tcpdump,一份完整的抓包指南请查收!
    这些好用的 Chrome 插件,提升你的工作效率
  • 原文地址:https://www.cnblogs.com/skiler/p/6964363.html
Copyright © 2020-2023  润新知