ReadMe API

ReadMe Documentation

Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!

Get Started

rdme command-line client

If you want command-line access to our API, you can use the rdme command-line client (CLI). The rdme CLI is simply a wrapper for the ReadMe API. It's useful if you need to programmatically call the ReadMe API from the command line as part of some automated script.

Information regarding our rdme client and its capabilities can be found on the npm page here.

Installation

📘

Node version 8 or higher is required!

$ npm install rdme

Usage

via rdme login

Logging In

$ npx rdme login

You will be prompted with your username and password. Once entered, you'll be able to select a project subdomain. Upon successful login, you will be greeted with this message: Successfully logged in as {user} to the {project-subdomain} project.

Uploading a new OpenAPI/Swagger file to ReadMe

This will upload the OpenAPI/Swagger file to the subdomain that was selected in the rdme login step. If you want to switch projects, you will need to login again to choose another project.

$ npx rdme swagger {path-to-swagger.json}

🚧

Version Matching

The version number in your specification file must match the version number in your ReadMe project.

As of rdme version 3.2.0, the version number in your specification file no longer needs to match the ReadMe project version.

Editing an existing OpenAPI/Swagger file

In your admin dashboard, you can find the unique ID by navigating to your API Definitions page. The unique ID will be found next to each definition.

$ npx rdme swagger {path-to-swagger.json} --id={existing-id}

via API Key

Uploading a new OpenAPI/Swagger file to ReadMe

This will upload the OpenAPI/Swagger file to the project that is associated with the api-key you've entered. To upload an OpenAPI/Swagger file to a different project, simply provide a different API Key!

$ npx rdme swagger {path-to-swagger.json} --key={api-key}

Updated 5 months ago


rdme command-line client


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.