Rate My OpenAPI

ratemyopenapi.com - the API

Endpoint:https://api.ratemyopenapi.com

Upload OpenAPI Spec & Get Report

POST

https://api.ratemyopenapi.com

/sync-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

Upload OpenAPI Spec & Get Report › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Upload OpenAPI Spec & Get Report › Request Body

apiFilestring · binary · required
The OpenAPI v3.x spec. JSON and YAML are supported.

Upload OpenAPI Spec & Get Report › Responses

Full Open API report

resultsobject

POST /sync-report

curl --request POST \
  --url https://api.ratemyopenapi.com/sync-report \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "apiFile": "apiFile"
}
'

shell

Show example in

Request Body Example

{
  "apiFile": "apiFile"
}

json

Example Responses

No example

json

application/json

Get your report by ID

GET

https://api.ratemyopenapi.com

/reports/{reportId}

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.

Get your report by ID › path Parameters

reportIdstring · required
The ID of your report (a uuid)
Example: 7cf20e71-f5df-487b-a145-0825b91db7cd

Get your report by ID › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get your report by ID › Responses

Success

GET /reports/{reportId}

curl --request GET \
  --url https://api.ratemyopenapi.com/reports/:reportId \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

json

application/json

Get Simple Report

GET

https://api.ratemyopenapi.com

/reports/{reportId}/simplified

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.

Get Simple Report › path Parameters

reportIdstring · required
The ID of your report (a uuid)
Example: 7cf20e71-f5df-487b-a145-0825b91db7cd

Get Simple Report › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Simple Report › Responses

The simplified API report

versionstring
Version of the OAS file.
titlestring
Title of the OAS file.
fileExtensionstring
File extension of the uploaded spec, either json or yaml.
docsScorenumber
The documentation score. Can high quality docs be generated from this API Spec?
completenessScorenumber
The completeness score. Does the API spec include many useful, but not required properties?
scorenumber
The overall score. A combination of the other scores.
securityScorenumber
The security score. How secure is the API based on OWASP standards?
sdkGenerationScorenumber
The SDK Generation score. How easily can SDK's be generated from this API Spec?
shortSummarystring
A short summary of the issues with the API Spec.
longSummarystring
A longer summary of the issues with the API Spec.

GET /reports/{reportId}/simplified

curl --request GET \
  --url https://api.ratemyopenapi.com/reports/:reportId/simplified \
  --header 'Authorization: <string>'

shell

Show example in

Example Responses

No example

json

application/json

Get the OpenAPI doc for this API

GET

https://api.ratemyopenapi.com

/openapi

Download the OpenAPI doc powering this documentation.

Get the OpenAPI doc for this API › Responses

Success

GET /openapi

curl --request GET \
  --url https://api.ratemyopenapi.com/openapi

shell

Show example in

Example Responses

No example

json

application/json

Upload OpenAPI Spec & Get Report

POST

https://api.ratemyopenapi.com

/sync-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

Upload OpenAPI Spec & Get Report › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Upload OpenAPI Spec & Get Report › Request Body

apiFilestring · binary · required
The OpenAPI v3.x spec. JSON and YAML are supported.

Upload OpenAPI Spec & Get Report › Responses

Full Open API report

resultsobject

Get your report by ID

GET

https://api.ratemyopenapi.com

/reports/{reportId}

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.

Get your report by ID › path Parameters

reportIdstring · required
The ID of your report (a uuid)
Example: 7cf20e71-f5df-487b-a145-0825b91db7cd

Get your report by ID › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get your report by ID › Responses

Success

Get Simple Report

GET

https://api.ratemyopenapi.com

/reports/{reportId}/simplified

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.

Get Simple Report › path Parameters

reportIdstring · required
The ID of your report (a uuid)
Example: 7cf20e71-f5df-487b-a145-0825b91db7cd

Get Simple Report › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Simple Report › Responses

The simplified API report

versionstring
Version of the OAS file.
titlestring
Title of the OAS file.
fileExtensionstring
File extension of the uploaded spec, either json or yaml.
docsScorenumber
The documentation score. Can high quality docs be generated from this API Spec?
completenessScorenumber
The completeness score. Does the API spec include many useful, but not required properties?
scorenumber
The overall score. A combination of the other scores.
securityScorenumber
The security score. How secure is the API based on OWASP standards?
sdkGenerationScorenumber
The SDK Generation score. How easily can SDK's be generated from this API Spec?
shortSummarystring
A short summary of the issues with the API Spec.
longSummarystring
A longer summary of the issues with the API Spec.