API specifications

YourSpecs hosts your Open API specifications. Manually upload your specification files in the editor, and they'll be available after publishing. Each specification has a name and a unique permalink (e.g., "/specs/petstore.openapi.json," "/specs/bookstore.openapi.json").

API spec file properties

API spec name: The display name that appears on the API list page.

Permalink: A shortened version of "permanent link." This identifies the specification file's location on the website. It's always a path relative to the website's root (e.g., "/specs/petstore.openapi.json," "/specs/bookstore.openapi.json").

Description: The Open API description imported from the specification file.

Adding new API specification file

1. Go to the "API Specifications" section in the Main panel;

2. Click the "Upload Spec File" button;

   The "Upload File" dialog opens, letting you choose an API specification file. The file is imported and indexed for API search upon upload. Afterward, you'll see it in the API specifications list.

3. Select the specification in the list to view and edit its name, permalink, and other properties.

You can continue editing, even if you close or navigate away from the "API specifications" view.