API Reference

Create an API definition

post
https://api.readme.com/v2/branches//apis

Create an API definition in the API Reference section of your ReadMe project.

📘

This route is only available to projects that are using ReadMe Refactored.

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

Project version number, stable for your project's stable version, or a valid branch name.

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 about 1 month ago

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

Updated about 1 month ago