Add an API (Basics)
How to add an API to RapidAPI in a few quick steps.
This guide will walk you through the easy process of adding your API to RapidAPI by using the Provider Dashboard. Listing your API exposes it to over a million developers in a matter of minutes! The RapidAPI Provider Dashboard is our main hub for adding and managing APIs.
To add an API click Add New API on the left-hand side of the dashboard.
In the first screen, you'll specify the API Name, a Short Description that appears in search, and the API's Category.
Categories
Each API belongs to a single category, such as SMS or Translation. Categories are a mechanism used to help organize and discover APIs.
Specifying your API
There are several different options for specifying your API. By default, an API will use the UI definition through RapidAPI. If you would like to automate this process by uploading an API spec file, simply select "OpenAPI" and upload your OpenAPI file.
OpenAPI Provisioning
Within Open API Provisioning, we currently support:
- swagger: โ2.0โ
- openapi: โ3.0.0"
- openapi: โ3.0.1โ
- openapi: "3.0.2"
You can also choose to import a Postman Collection by simply uploading the Postman Collection file.
RapidAPI supports GraphQL APIs, so you can specify using a GraphQL schema if applicable.
Best practices for naming your API
- Choose a name that is easily discoverable and descriptive
- Capitalize the API's name
- Remove API from the name
Special characters in API names
Spaces and dashes are allowed in an API's name. While technically allowed by the RapidAPI backend, special characters such as (!@#$%^&*(){}[]||) are not encouraged in an API's name. If you do include these special characters, they will not appear in the URL for the API. For example, an API named
Test-(!@#$%^&*()-{}[]||)Test
will be simplified to something liketest-test
in the API's URL.
Overview tab
After clicking 'Add API', the next page that you will see is the API overview definition. This is where you can add in more detailed information such as a longer description that appears on the API listing, a website URL, terms of use, and a logo for your API.
Updated over 1 year ago