Publishing an API Portal
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.
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.
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. The last supported version of Hugo is v0.145.0.
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.
API Portal prerequisites
- A role with the API Portal - Create and edit permission. This permission is available in the predefined API Portal Publisher role and can also be added to any other role. User roles and permissions can be modified by a Security Administrator in Talend Management Console. For more information, see Managing roles.
- A GitHub account with the rights to create or write to a private repository. If you want to publish to GitHub Pages, you need a GitHub plan that allows you to publish from a private repository.