|API RANK| by Escape.tech
Benchmark and ranking of 5138+ public APIs by Escape.tech
Policyholder API (ranked 4393 of 5138)
https://escape-data-and-specs.s3.fr-par.scw.cloud/specs/postman_com_se_professional_sandbox_workspace_pro_public_test_2_json.jsonGENERAL INFORMATION
This API is designed to show how you might mock, test document a new API. In this case, we're assuming that we're going to create a basic user management API.
It has basic CRUD operations listed below.
Hit the "Run in Postman" button to see the pre-request and test scripts powering this collection.
Try running the collection through the Collection Runner to see how the mock allows us to scope out all our responses and write our tests in advance.
Summary
Having undergone the effort of building out our collection in Postman first:
- Using Postman Mocks
- Writing tests
This has allowed us to then build out our API to match, meaning we could:
(Update the url
in the environment to http://localhost:3000
and run the following Node API: https://github.com/matt-ball/users-api)
- Debug our API as it was being built
- Ensure parity with our mocks, meeting the designed blueprint
- Run tests against the API as it was being built so that it's watertight
As a result:
- We now have a
...
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 0/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 1,840 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 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!