Citrix Application Delivery Management

Crear o cargar una definición de API

Una definición de API es un documento que describe una API utilizando estándares de especificación OpenAPI (Swagger 2.0, OpenAPI 3.0.x). Esta definición puede contener rutas de recursos API y métodos para operarlas. Puede agregar definiciones de API a ADM y luego implementarlas en una puerta de enlace de API (Citrix ADC).

Puede crear definiciones de API de una de las siguientes maneras:

Nota

Actualmente, ADM admite el análisis de archivos de especificación OAS que utilizan Swagger 2.0 o openapi 3.0.1.

Cargar la especificación de la OEA

Puede cargar la especificación OAS a la GUI de ADM.

  1. Vaya a Aplicaciones > API Gateway > Definiciones API.

  2. Haga clic en Agregar.

  3. Seleccione Cargar Especificación OAS.

    Nota

    Asegúrese de que el archivo de especificación de OAS esté en formato YAML o JSON. Y, este archivo no debe contener referencias externas. Actualmente, ADM es compatible con la versión 2.0 de Swagger.

  4. Examine una especificación de OAS desde su ordenador local y cárguelo a ADM.

Crear una definición de API

Puede crear su propia definición de API en la GUI de ADM.

  1. Vaya a Aplicaciones > API Gateway > Definiciones API.

  2. Haga clic en Agregar.

  3. Seleccione Crear su definición y especifique lo siguiente:

    • Nombre : nombre para la definición de API.

    • Definición de API : una definición debe incluir título, versión, ruta base y host. Puede especificar un nombre de dominio o una dirección IP en el campo Host.

    • Recursos de API : agregue varios recursos API a su definición. Cada recurso tiene una ruta de acceso y un método soportado.

    Crear una definición de API

  4. Haga clic en Crear.

Ver definiciones de API

La página Definiciones de API muestra la definición cargada. Haga clic en Ver para ver los siguientes detalles de definición de API:

  • Nombre: Muestra el nombre de una definición de API.

  • Definición de API: Muestra el título, la versión, la ruta base y el host de una definición.

  • Recursos de API: Enumera los recursos de API en una definición de API y sus métodos para operarlos.

A continuación, implemente esta definición en una puerta de enlace API.

Crear o cargar una definición de API