AwesomeAPI: documentation generator
Create beautiful and interactive API documentation from OpenAPI or Swagger specification with a great variety of styling options
Powerful Visual Editor
Create a stunning documentation from just an API specification and customize it in a real time view editor . Every change you make can be seen right away without any lag-time, saving, or refreshing.
Choose one of the 4 predefined color themes or create your own by changing each and every desired item color, define font sizing, manage document layouts, add navigation.
Easily export your API documentation into PDF. No need to save the changes every time before export, just add an OpenAPI specification, apply any required theme or colors, and download the documentation files right away.
Create beautiful and interactive API documentation with a great variety of styling options. Use Embedded OpenAPI specification editor with syntax highlighting to add your API spec and turn it into a ready-made documentation. The editor supports YAML and JSON formats, OpenAPI specification v2.x, v.3.x.
Built-in integration with BitBucket, GitHub, GitLab allows you to add spec that is located in the private repository.
Choose one of the 4 color themes or simply create a new one by changing colors, fonts and layout.
Real-time-view editor allows you to make the changes on-the-go.
Add navigation to your documentation by pulling the headings from the OpenAPI description field into the side menu.
Easily export your newly created API documentation into PDF.
Additionally you will find:
- Built-in console to Try out the APIs;
- Search and advanced search options;
- Tree/Table view for schema;
- Markdown support;
- Code examples and inline code;
- Syntax Highlighting;
- Predefined API keys and servers.
Privacy and security
AwesomeAPI: documentation generator integrates with your Atlassian product. This remote service can:
- Read data from the host application
specification editor with syntax highlighting