Importing API reference documentation into a MadCap Flare project

Last year, we blogged about creating an API documentation portal using MadCap Flare (see also: Example of API documentation portal using MadCap Flare). Since then, a number of people have contacted us to ask for more details on ways to do this. We’ve put together a video outlining the different approaches and issues. This approach can work with… Read more »

Incorporating the Stripe API look and feel into a MadCap Flare project

Back in July, we looked at creating an API documentation portal using MadCap Flare (see also: Example of API documentation portal using MadCap Flare) . We done some further testing. We’ve created two new examples for  API documentation that had been generated with the Stripe API look and feel and imported into Flare: Example A – Replacing… Read more »

Example project – API documentation portal using MadCap Flare

Note: This post follows on from two previous posts on creating a unified API documentation portal: Creating an API documentation portal with MadCap Flare and Swagger/OpenAPI Example of API documentation portal using MadCap Flare We’ve just uploaded an example project of an API documentation portal created using MadCap Flare: API documentation portal home page Swagger… Read more »

Example of API documentation portal using MadCap Flare

This post follows on from our Creating an API documentation portal with MadCap Flare and Swagger/OpenAPI post. It shows screenshots of a test project we created. We used Swagger’s “petstore” example API specification as the source content. We didn’t spend any time modifying the stylesheets – these are just proofs of concept. API documentation Home page… Read more »

Creating an API documentation portal with MadCap Flare and Swagger/OpenAPI

MadCap Software has published a whitepaper called The Definitive Guide to Creating API Documentation. It covers ten best practices for writers, and it describes how you can use MadCap Flare to implement these when you are writing API documentation. In this post, we’ll look at whether we can combine automatically generated REST API reference documentation with… Read more »