ratemyopenapi.com - the API
API for interacting with the ratemyopenapi.com service. This API helps evaluate your OpenAPI definition files and provide a comprehensive score based on four key categories: Documentation, SDK Generation, Security & Completeness.
https://api.ratemyopenapi.comAuthentication
Upload OpenAPI Spec & Get Report
Upload an API spec (OpenAPI v3.x only). A report will be generated synchronously and return the simplified report generated for the spec.
Example request:
curl --request POST -H 'Authorization: Bearer YOUR_KEY_HERE' -F 'apiFile=@/path/to/my-openapi.json' --url https://api.ratemyopenapi.com/sync-report
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Request Body
FormData containing the OpenAPI file.
apiFile
The OpenAPI v3.x spec. JSON and YAML are supported.
1
Get your report by ID
Access your report using the ID given by the /rate endpoint. Note, the report may take a few seconds to generate, during which time you might receive a 404.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
reportId
The ID of your report (a uuid)
1
Get Simple Report
Fetches the simplified report generated by the Upload OpenAPI Spec endpoint. You may have to wait 10-20 seconds after upload for the report to be generated before fetching it.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
reportId
The ID of your report (a uuid)
1
Get the OpenAPI doc for this API
Download the OpenAPI doc powering this documentation.
1