There are many ways in which an API can be not fully functional. These include:
- Invalid response codes
- Invalid response headers
- API time-outs
- Slow API response with respect to response data bytes
- Incorrect required data in JSON responses
- Missing required text in response bodies
- Slow response for customers in specific locations
Validating an OpenAPI with Apicurio
You visit Apicurio and register/login.
After logging in successfully, you are redirected to the Dashboard tab.
In the Import API tab, we need to supply our OpenAPI definition, either from URL or a file:
Along with the overview of the contents of our API ,on the top right part of the screen we can identify the issues that correspond to the validation problems of our API.
By clicking on Go to problem, you are directed to a sub-tab where you can investigate in more detail, with exclamation triangles pointing directly to the issues.
Overall, through Apicurio we get a first indication on issues of our API and how to solve them.