Importing API docs using one-click OpenAPI spec importer

You can easily set up your API docs using our one-click OpenAPI spec importer. All you need is the .json or .yaml file where the specs are mentioned.

1. Go to the dashboard.

2. Click on the Guides option in the left sidebar and then click on New API reference.

   

3. A dialog box will open, where you will be prompted to enter the following details:

   • URL - This should be the yaml or json file url that includes the specs for your API docs. It will look something like https://openapi.companyname.com/v2-pcv2/index.json.

   • Name (optional) - Enter a name for your API docs, this can be something like API reference.

   • Slug (optional) - Add the route where you want your API references to be redirected to.

   

4. Once you have filled in the details, click on Import and create, and Hashnode will generate an API reference for you, along with an API playground.