Add an API definition

June 3, 2020

Contributed by: R

An API definition is a document that describes an API that follows OpenAPI Specification standards. This definition can contain API resource paths and methods to operate them. You can add API definitions to ADM then deploy them to an API gateway. With this deployment, API Gateway ensures secure and reliable access to API resources in the definition.

To add an API definition in the ADM GUI, perform the following steps:

Navigate to Applications > API Gateway > API Definitions.
Click Add.
Click Upload OAS Specification.

Note

Ensure the OAS Specification file is in YAML or JSON format. And, this file must not contain external references. Currently, ADM supports Swagger version 2.0.
Browse an OAS specification from your local computer and upload to ADM.

The API Definitions page lists the uploaded definition. Click View to see the following API definition details:

Name – Displays the name of an API definition.
API Definition – Displays title, version, base path, and host of a definition.
API resources – Lists the API resources in an API definition and their methods to operate them.

Next, deploy this definition to an API Gateway.

The official version of this content is in English. Some of the Citrix documentation content is machine translated for your convenience only. Citrix has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Citrix product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Citrix, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Citrix will not be held responsible for any damage or issues that may arise from using machine-translated content.

Add an API definition

June 3, 2020

Contributed by: R

Add an API definition

Add an API definition

In this article