The state of public APIs| Submit an API

|API RANK| by Escape.tech

Benchmark and ranking of 5138+ public APIs by Escape.tech

Back to the list Request ranking update

人井盖Restful API说明文档 (ranked 4112 of 5138)

https://escape-data-and-specs.s3.fr-par.scw.cloud/specs/uumKuuf1b_6DdeUKQOmsZ_restful_api_json.json

GENERAL INFORMATION

<table>
<thead>
<tr>
<th>版本</th>
<th>修订人</th>
<th>修订时间</th>
<th>修订说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>1.0.0</td>
<td>李旭佳</td>
<td>2019-03-26</td>
<td>初版</td>
</tr>
</tbody>
</table>

HTTP方法

  • OPTION 获取某URI支持的方法列表
  • GET 用于获取资源的列表或单个资源信息
  • POST 向某种资源列表创建一个新的资源
  • PUT 整体更新一个资源的信息，数据体中不带的属性，将会被默认值替代
  • PATCH 部分更新一个资源的信息，数据体中不带的属性，将保持不变
  • DELETE 删除某个资源

传参方式

  • header 携带在HTTP请求头部
  • path URL路径中的参数，如 /sites/{siteId}/ 中的siteId是path参数。
  • query URL中?后的参数，如 /devices/?siteId={siteId}中大括号内的siteId

URL风格

API的URL遵循 /{type}/{objectId}/?para1={para1}&para2={para2} 的风格。其中，type是资源的类型。

如果访问的URL为不带objectId，而仅仅是/{type}/，则访问的对象是类型为“type”的对象列表。

而如果访问的是 /{type}/{objectId}/ 这样的URL，访问的对象是id和类型都匹配的一个具体的对象。

?后的查询参数主要是在进行列表访问的时候对列表中的对象进行条件过滤。在Restful的风格中，

查询参数不可以用于对资源进行修改。所有修改资源的动作必须通过POST、PUT、PATCH、DELETE方法来实现。

SECURITY 4/5

The security score of an API is computed as the number of OWASP top 10 vulnerabilities detected in the API.

  • OWASP issues detected: API7:2023

PERFORMANCE 1/5

The performance score is derived from the median response time of the API, sometimes referred as p50. The median is the value separating the higher half from the lower half of a data sample, here the response times of the API.

  • The median response time of the API is 856 ms .

Get p50 under 220 ms to get a 4/5 score.

RELIABILITY 5/5

The reliability score is derived from the number of inconsistent server responses, either server errors or non-conforming return values.

  • Self compliance: response objects matched the declared response types.
  • Server errors: the server did not return any 5xx error.

DESIGN 2/5

The design score reflects the quality of the specification file (usually named openapi.json or swagger.json). Having a high-quality specification file (with up-to-date types and examples) help developers understand the API and tools produce relevant documentation.

  • Respects OpenAPI 3.0.1 schema specification.
  • Contains comments and summaries.
  • Contains examples.
  • Does not contain duplicated objects.

Popularity 0/5

The popularity score is computed from the number of references to the API found on the internet. Have your API used by many developers to get a higher score!

Last scanned: 5/4/2023