Crear o cargar una definición de API

Una definición de API es un documento que describe una API utilizando los estándares de la especificación OpenAPI. Esta definición puede contener rutas de recursos de API y métodos para operarlos. Puedes agregar definiciones de API a NetScaler Console y luego implementarlas en una puerta de enlace de API (NetScaler).

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

Nota:

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

Cargar la especificación OAS

Puedes cargar la especificación OAS en la GUI de NetScaler Console.

  1. Navega hasta Security > API Security > API Definitions.

  2. Haz clic en Add.

  3. Selecciona Upload OAS Specification.

    Nota:

    Asegúrate de que el archivo de especificación OAS esté en formato YAML o JSON. Además, este archivo no debe contener referencias externas.

  4. Explora una especificación OAS desde tu equipo local y cárgala en NetScaler Console.

Crear una definición de API

Puedes crear tu propia definición de API en la GUI de NetScaler Console.

  1. Navega hasta Security > API Security > API Definitions.

  2. Haz clic en Add.

  3. Selecciona Create Your Definition y especifica lo siguiente:

    • Name - Un nombre para la definición de API.

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

    • API Resources - Agrega varios recursos de API a tu definición. Cada recurso tiene una ruta y un método compatible. Haz clic en Add. El recurso se agrega a la tabla Added Resources. Haz clic en Delete para eliminar un recurso de API.

    Crear una definición de API

  4. Haz clic en Create.

Ver definiciones de API

La página API Definitions enumera la definición cargada. Haz clic en View para ver los siguientes detalles de la definición de API:

  • Name – Muestra el nombre de una definición de API.

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

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

Crear o cargar una definición de API