|API RANK| by Escape.tech
Benchmark and ranking of 5138+ public APIs by Escape.tech
Docker Engine API (ranked 71 of 5138)
https://escape-data-and-specs.s3.fr-par.scw.cloud/specs/Docker_Engine_API_856db929_2e35_4b65_8155_7c8a37d54c05_yaml.yamlGENERAL INFORMATION
The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API.
Most of the client's commands map directly to API endpoints (e.g. docker ps is GET /containers/json). The notable exception is running containers, which consists of several API calls.
Errors
The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format:
{
"message": "page not found"
}
Versioning
The API is usually changed in each release of Docker, so API calls are versioned to ensure that clients don't break.
For Docker Engine 17.09, the API version is 1.32. To lock to this version, you prefix the URL with /v1.32. For example, calling /info is the same as calling /v1.32/info.
Engine releases in the near future should support this version of the API, so your client will continue
...
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: A05:2021
PERFORMANCE 4/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 151 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.0 schema specification.
- Contains comments and summaries.
- Contains examples.
- Does not contain duplicated objects.
Popularity 5/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!