|API RANK| by Escape.tech
Benchmark and ranking of 5138+ public APIs by Escape.tech
Soupify™ (ranked 1953 of 5138)
https://escape-data-and-specs.s3.fr-par.scw.cloud/specs/u8ConxsYRvWG3endK3svm_soupifytm_json.jsonGENERAL INFORMATION
This is a backend server API for storing recipes and meals we coocked.
RestfulAPI for the re-branding project of Engineering-Students-Recipes Company to their new company, Soupify™. This project was creating as a group project for Web-Development-Environments course @Ben-Gurion University. For more details on the process/design please read the linked README.md file.
Authorization:
A logged-in user must update/delete his resources ONLY! Otherwise, he will receive 403 Unauthorized Error.
Base URL: {your_custom_url}/api
Validity:
All parameters sent to any API endpoint are validated according to the following criteria:
- Required vs Optional
- Numeric vs Alpha vs Alphanumeric
- Unique vs Multiple
- Min/max length of strings
- Min/max values of numbers
- Date formats
Request Headers:
All request headers must have the following fields:
Authorization: Bearer <user's auth JSON Web Token>
You can use this header token for admin access:
--
...
Contact
- Name: serfata@post.bgu.ac.il
License
- Name: Apache 2.0
- See License
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 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 118 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!