Learn how to design a beautifully branded workspace with Stoplight Platform. Register for the interactive workshop here.
Generate API Documentation Instantly
Stoplight’s instant online API Documentation generator tool makes it easy to generate API documentation directly from your API specification. Upload your spec into the API generator and voila! Generate API docs online from an existing specification and publish them online immediately using our API docs tool.
Stoplight allows you to reference other sources to automatically populate your Hub with content. We call this “powering” a page, subpage, or block. You can power a page, subpage, or block with a Markdown or OpenAPI Specification (formerly known as Swagger) document from the current file, a file from the current project, a file from another project, or a file from an external source.
One of the most common issues we wanted to solve was not only being able to generate API documentation using our API docs generator, but also making sure it stays up-to-date and accurate. Many documentation solutions treat documentation separately from the API design process. This ultimately leads to out-of-date documentation due to changes to the API not being reflected in documentation. Stoplight’s API documentation tool connects your documentation to your API specification. Whenever you make a change to your API spec, the changes immediately get pushed to your documentation, so you never have out-of-date documentation again.
Theming brings your API documentation to life. It allows you to easily modify color schemes and add textures to your documentation. There are four different theme settings that can be modified: Primary Color, Secondary Color, Background, and Texture.
Add style and flair to your documentation by adding Custom CSS. Want to embed your documentation into an existing site? Utilize Custom CSS to ensure the style matches your brand.