API documentation
Writerside supports generating API docs from OpenAPI and Swagger specifications.
There are two main problems that documentation authors may have with API docs:
Generated API documentation is usually a separate website from the rest of your documentation. This can lead to difficulties in maintaining a cohesive and integrated documentation set that provides a holistic view of your product or service.
When trying to integrate API documentation with the rest of your content, this usually requires manual editing to enhance the autogenerated reference with manually written parts.
To address these issues, Writerside offers a solution that combines the benefits of automatic API documentation generation from OpenAPI and Swagger specifications with a seamless integration into your overall document content.
Writerside provides several built-in project templates including a template with a sample API documentation project.
Create a new API documentation project
Writerside provides a built-in template with a sample API documentation project that you can use as an example or starting point.
In the Welcome to Writerside dialog, click New Project.
If you already have a project open, select from the main menu.
In the New Project wizard, select API Docs.
Specify the name and location for your new project and click Create.