Skip to main content

Prepare Swagger OpenAPI for Import

You can import Swagger OpenAPI content as json or yaml files. Before you can import your content to Paligo, the project requires some preparation first.

When the import is complete, the Swagger OpenAPI content appears as topics in the Content Manager. You can use Paligo to edit or add content to the topics if you wish. Note that there is also a publication that contains links to the topics. The publication acts as the table of contents for your OpenAPI content and it is where the structure of the documentation is set. You can create extra topics in Paligo and add them to the content imported from your OpenAPI, as well as integrate it with the rest of your software documentation created in Paligo.

You will probably want to use Paligo's HTML5 API layout for publishing as this layout provides the code sample panel as well as the main content. Learn more about the Publish Content.

Important

If your OpenAPI content has circular references, you will need to import your content in json format. The yaml import feature does not support circular references.

To import json or yaml content into Paligo:

  1. Make a zip file containing the json or yaml file that Paligo will import.

  2. Use the Import Wizard to import your content. Select Swagger OpenAPI as import type.

Tip

If you don't have an OpenAPI project yet, you can use this sample to test the import:  https://paligo.zendesk.com/hc/en-us/articles/360007352034-Download-API-Sample-Content. It is to be imported as a Paligo Export File (PEF).