Citrix Application Delivery Management service

Create or upload an API definition

March 23, 2021

Contributed by:

R R

An API definition is a document that describes an API using OpenAPI Specification standards (Swagger 2.0, OpenApi 3.0.x). 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 (Citrix ADC).

You can create API definitions in one of the following ways:

Upload Swagger OAS specification file
Create your own API definition

Note

Currently, ADM supports parsing OAS specification files that use Swagger 2.0 or openapi 3.0.1.

Upload the OAS specification

You can upload the OAS specification to the ADM GUI.

Navigate to Applications > API Gateway > API Definitions.
Click Add.
Select 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.

Create an API definition

You can create your own API definition in the ADM GUI.

Navigate to Applications > API Gateway > API Definitions.
Click Add.
Select Create Your Definition and specify the following:
- Name - A name for the API definition.
- API Definition - A definition must include title, version, base path, and host. You can specify a domain name or IP address in the Host field.
- API Resources - Add multiple API resources to your definition. Each resource has a path and supported method.
Click Create.

View API definitions

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.

Create or upload an API definition

March 23, 2021

Contributed by:

R R

March 23, 2021

Contributed by:

R R

Create or upload an API definition

Upload the OAS specification

Create an API definition

View API definitions

In this article