Writerside Help

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:

  • The generated API documentation lives in isolation, separate from the rest of your document content. This can lead to difficulties in maintaining a cohesive and integrated document that provides a holistic view of your product or service.

  • When trying to integrate API documentation with the rest of your content, manual editing is often required. However, often there is no ability to enhance 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.

Last modified: 23 May 2024