Importing OpenAPI/Swagger API reference content into MadCap Flare 2021 to create a developer portal

You can use MadCap Flare to create static site HTML knowledge bases and developer portals. In this video, we show how you can import an OpenAPI/Swagger API reference file, by using the new Markdown import feature. The benefit is that all of your content can have the same “look and feel”.

 

Here is screenshot and a link to an example Help file, where the OpenAPI file has been imported into Flare, using the Markdown import. The Markdown file has been imported, but no amendments have been made to the look and feel.

It also includes a second API reference example, where the content is displayed in HTML format.

 

Screenshot of API documentation in MadCap Flare

Example file of API documentation in MadCap Flare

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.