Configuring your portal with another Git provider
To use the API Portal feature with a Git provider other than GitHub, you can download the Starter Kit and your API documentation and push them to your repository.
Downloading the API Portal Starter Kit
Download the API Portal Starter Kit from Talend Cloud to use
it with your preferred Git provider.
For more information about the contents
of the template, see Repository architecture.
Procedure
-
Select API Portal Starter Kit (zip), then click
Download and save the file.
Results
Downloading your API documentation
Download API documentation and definitions to publish on your portal.
Procedure
-
Click Select API Documentation to
publish.
-
In the API Portal tab, click the
Download button to download documentation for an API and
save the file.
By default, the ZIP file downloaded contains:
- An index.md file containing the API documentation to be published on the portal.
- An openapi30.json file and a swagger20.json file containing the API definition in OAS 3.0 and Swagger 2.0 respectively. These files can be downloaded by users from the portal.
You can select the API definitions to download in the Settings. For more information, see Publishing downloadable API definitions.
