Skip to content

Introduction

API Console is a program that automatically generates documentation for an API project.

The magic starts with parsing API project with AMF parser and the result of parsing (the model) is passed to API Console.

API Console generation flow

The Console does not include AMF parser library. It is offered by MuleSoft as a separate, open source library. In the advanced topics read Parsing API project document to learn how to process your API project before passing the model to the console.

API Console is a web component (web custom element). It is build on top of web APIs so it can be used in any web environment and it works with any framework.

Special case for the API Console is when it works as stand-alone application, an API documentation portal. The console support this scenario by adding layout and navigation support to the application. See Usage documentation for detailed information.