Automated API documentation

[Peter Behrens]

I work in an agency. We create and maintain website projects.

Our frontend and backend developers are using bitbucket and bamboo.
More and more projects are being realized headless, e.g. craftcms with react.

we document our work results in confluence, e.g. cms api.

at the moment the documentation of the cms api is maintained manually in confluence.
Is there a plugin that automates the documentation?

[Merle Fischer]

Hi Peter,

to automate API documentation you could check if Open API (Swagger) Integration fulfills your needs https://marketplace.atlassian.com/apps/1219386/open-api-swagger-integration?hosting=server&tab=overview

We're currently giving Open API Documentation for Confluence a testrun and so far we're not experiencing any major trouble with that https://marketplace.atlassian.com/apps/1215176/open-api-documentation-for-confluence?hosting=cloud&tab=overview

Depending on what else you want to make more visible within Conlfuence  you maybe want to look into Include Bitbucket for Confluence as well (https://marketplace.atlassian.com/apps/1212529/include-bitbucket-for-confluence?hosting=server&tab=overview)

Hope this helps, cheers

Merle