API documentation - Cloud

Talend Cloud API Designer User Guide

Version
Cloud
Language
English (United States)
Product
Talend Cloud
Module
Talend API Designer
Content
Design and Development > Designing APIs
Talend Cloud API Designer allows you to document your API. Documentation is an important step in the life cycle of an API. Writing and maintaining documentation can be difficult, but Talend Cloud API Designer allows you to get your documentation automatically.

Who writes documentation and who reads it?

In Talend Cloud API Designer, you work in a team of API designers that are allowed to edit your API design. Your team members can contribute to the documentation of your API and generate a live preview.

Live Documentation can be shared with members of your team, partners, or anyone who might need to access it while it is still being developed.

Once your API documentation is ready to be made public, you can publish it on your API Portal. For more information, see Publishing an API Portal.