Publishing an API Portal - Cloud

Talend Cloud API Designer User Guide

Version
Cloud
Language
English
Product
Talend Cloud
Module
Talend API Designer
Content
Design and Development > Designing APIs
Last publication date
2024-03-13

The API Portal feature in Talend Cloud API Designer allows you to create an API portal to centralize the documentation for your APIs in order to easily share it with consumers.

After you create the API documentation, you can add your custom content and branding in the GitHub repository and publish your custom API Portal.
In the new API Portal tab, you can create a private GitHub repository containing a template for your portal. You can then push your API documentation to this repository in one click.
API Portal tab.

The portal, based on the static site generator Hugo, can easily be customized by adding your logo and colors to fit your branding, and by adding new pages for custom content. For more information about Hugo, see the Hugo documentation.

Once your portal is configured, you can deploy it to the target of your choice. Some examples of how to deploy a portal to various targets are available in the Deploying your portal.