One-click API reference

Using Hashnode’s One-click OpenAPI spec importer, you can easily import your API docs.

Here’s how you can do it:

1. Go to the docs dashboard.

2. Then click on the Guides option from the left sidebar and then click on +New. Since we are writing API docs, click on New API reference.

   

3. A dialog box will open, where you will need to fill the following fields:

   • URL - Your OpenAPI docs URL, with .json or .yaml extension. It should look like: https://companyname.swagger.io/api/v3/openapi.json

   • Name - This is an optional field. If you want, you can give it a name. For example - Pet store

   • Slug - This is an optional field, and you can update the slug to make your API docs direct to something like: https://companyname-docs.hashnode.space/api/apireference/updatePet

   

4. Once you are done, click on Import and create and your API reference is ready along with an API playground.