Citrix Application Delivery Management service

Add an API definition

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:

  1. Navigate to Applications > API Gateway > API Definitions.

  2. Click Add.

  3. 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.

  4. 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.

Add an API definition