<html><head><link rel="canonical" href="https://www.jetbrains.com/help/writerside/api-documentation.html.md/" data-react-helmet="true"/></head><body># API documentation

Writerside supports generating API docs from [OpenAPI](https://www.openapis.org/) 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.

&gt; **Note:**
&gt; Be aware of the following limitations in the current implementation:
&gt;
&gt;
&gt;
&gt; * Only the following [component types](https://swagger.io/docs/specification/components/) are supported: schemas, parameters, and responses. If you need support for other types, comment or create a subtask of [WRS-2998](https://youtrack.jetbrains.com/issue/WRS-2998).
&gt;
&gt; * Markdown is supported only for descriptions of endpoints. Markdown descriptions for objects and responses are not supported yet. See [WRS-3507](https://youtrack.jetbrains.com/issue/WRS-3507).
&gt;
&gt; * No support for [webhooks](https://spec.openapis.org/oas/v3.1.0#oasWebhooks). See [WRS-2552](https://youtrack.jetbrains.com/issue/WRS-2552).
&gt;
&gt; * No support for security schemas. Describe the authentication process for an API manually.
&gt;
&gt; * No support for [external references](https://swagger.io/docs/specification/using-ref/) (from other files and URLs).
&gt;
&gt;
&gt;
&gt; OpenAPI specifications can be quite complex. If you notice that something important for you is not supported, look for a relevant ticket [in our issue tracker](https://youtrack.jetbrains.com/issues/WRS) and vote for it or create a new feature request.

Writerside provides several built-in [project templates](projects.html#project_templates) including a template with a sample API documentation project.

Procedure: 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.

1. From the main menu, select `File | New | Project`.

2. In the New Project wizard, select Writerside on the left, then select API Docs, and then click Next.

3. Specify the name and location for your new project and click Create.

</body></html>