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

Swagger Specification

You can read about the swagger specification on the swagger site. Below are some tips on what each swagger object translates to in ReadMe and what additional features we have on top of it! Also make sure your JSON is valid JSON Schema.

Categories, Pages and Subpages

To read about how we create these for you based on your swagger file please read: Categories, Pages and Subpages

Request Examples

The swagger spec does not have code examples, so we will generate code samples for you in curl, Node.js, Ruby, Python, and JavaScript.

Response Examples

Code samples will be displayed if you have an example object in your response object.

Security Definitions

Your security definitions will be displayed under the authentication modal of your docs.

Swagger Extensions

To read about the extensions that we've added to the Swagger Spec, please read: Swagger Extensions.

Swagger Specification

Suggested Edits are limited on API Reference Pages

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