Skip to main content

Introduction to 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 API Portal tab in Talend Cloud API Designer, you can generate a template for your portal and populate it with your API documentation. For more information about these steps, see Publishing an API Portal.
An API documentation generated from Talend Cloud API Designer can be packaged together with custom content and branding assets in GitHub and then published as a custom API portal.
Once your portal is ready to be published, you can deploy it to your preferred target. This guide describes how to deploy a portal to:
  • GitHub Pages
  • AWS Amplify
  • Azure Static Web Apps
  • Docker

It also contains some information on how to get started with a custom deployment. For more information about deploying a Hugo static website, see the Hugo documentation.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!