API Reference

Validate an API

post
https://api.readme.com/v2/validate/api

Validates an API definition for uploading to your ReadMe project.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The API definition to upload. We provide full support for OpenAPI 3.x and Swagger 2.0 and experimental support for Postman collections.

The API definition to upload. We provide full support for OpenAPI 3.x and Swagger 2.0 and experimental support for Postman collections.

string

The API definition.

string
Defaults to form

The source that the API definition is being uploaded through.

string

The URL where the API definition is hosted.

Response

Updated 2 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago