Skip to content

RESTful API介绍

更新时间:

本节介绍 RESTful API 请求的组成,并以示例说明如何调用RESTful API。

什么是 RESTful API

RESTful API 是一种互联网软件架构的设计规范。

请求的组成

请求 URI:

{URI-scheme} :// {Endpoint} / {resource-path} {query-string}

  • URI-scheme:表示用于传输请求的协议,当前所有 API 均采用 HTTPS 协议。

  • Endpoint:指定承载 REST 服务端点的服务器域名或 IP。

  • resource-path:资源路径,也即 API 访问路径。从具体 API 的 URI 模块获取。

  • query-string:查询参数,是可选部分,并不是每个 API 都有查询参数。

常用请求方式

  • GET:获取资源

    例如图片、css文件、js文件等。在 RESTful API 中,一般用来获取数据,例如列表、详情等。

  • POST:传输实体主体

    一般用于提交数据、创建操作。

  • DELETE:删除数据

  • PUT:传输文件

    在 RESTful API 中,一般用做修改数据。