Talend Cloud API Designer User Guide - Cloud

Version: Cloud
Language: English
Product: Talend Cloud
Module: Talend API Designer
Content: Design and Development > Designing APIs

Introduction to Talend Cloud API Designer
Talend Cloud API Designer architecture
About APIs
API design
Creating an API
Defining general API information
Creating a section
Creating a data type
Using combinations
Using data type attributes
Creating a resource
Creating an operation
Defining responses
Creating a text block
Cloning an element
Renaming an API
Using markdown
Working with reusable components
Creating a component
Cloning a component
Extracting to a component
Using a component
Using a path variable component
Using a response component
Un-using a component
Deleting a component
Working with multiple versions
Creating a new API version
Deleting an API version
Working with OpenAPI Specification and RAML definitions
Talend extensions and annotations
OpenAPI Specification 3.0 support
Using description fields
Importing a definition
Exporting a definition
Transformations at export
Working with API gateways
Exporting a definition for an API gateway
API gateway compatibility mode
Defining a security scheme compatible with AWS API Gateway
Pushing an API version to GitHub
Unlinking your GitHub account
Designing API security
Creating a security scheme
Defining your API security
API mocks
Enabling your API mock
Mocks behavior
Response generation with API mocks
Using examples
Making calls to your API mock
API documentation
Enabling the Live Documentation
Disabling the Live Documentation
Allowing third-party cookies in your browser
Publishing an API Portal
API Portal prerequisites
Configuring your portal with GitHub
Repository restrictions
Repository architecture
Managing your API documentation
Publishing downloadable API definitions
Configuring your portal with another Git provider
Downloading the API Portal Starter Kit
Downloading your API documentation
Fetching your API documentation with the management API
Customizing your portal
Customizing the branding
Changing the portal title
Changing the portal logo
Customizing the theme
Theme variables
Updating the theme
Organizing and adding content
Customizing the landing page
Organizing your API list
Creating a new page
Deploying your portal
Talend Cloud API Tester integration
Resetting your GitHub settings
Trying your API in Talend Cloud API Tester
Trying an API
Trying an operation
Sharing an API
Sharing all versions of an API
Sharing a specific version of an API
Talend Cloud API Designer Management API

Back to home page