ReadMe Documentation

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

Manual API Settings

Provide testing and interactivity to your API endpoint documentation.

Configure

You must define your API before you can add API endpoints. In your ReadMe dash, navigate to API Reference > API Definitions > Add your first API

If you have an OAS3 spec file, upload that instead!

Design

Name your API (this will only be visible in the ReadMe dash, customers will not see this name) and set your base URL

Authentication

You have the usual three authentication methods to choose from. For API Keys you can select whether it is a header or a query param. Typing in authorization will allow you to select the type of authorization as well.

API Explorer

The API explorer is automatically enabled, but you can disable it under additional options. The API proxy is used to prevent and CORS permission errors, so make sure you allow try.readme.io if you turn this off and want the API explorer to work.

Other

You can add additional API Headers and select the Mimetypes of your API requests and responses. We will generate code samples for you automatically, but if you would like to display the one you have in your API setup, simply uncheck this option. If you turn off auto code samples, we will still display any custom examples that you have added to particular endpoints.

When you are done adding your API Settings, head over to the newly created category and start defining your endpoints!

Updated 7 months ago


Manual API Settings


Provide testing and interactivity to your API endpoint documentation.

Suggested Edits are limited on API Reference Pages

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