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 añadir definiciones de API a NetScaler Console e implementarlas en una puerta de enlace de API (NetScaler).

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

Nota:

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

Cargar la especificación de la OEA

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

  1. Vaya a Seguridad > API Security > Definiciones de API.

  2. Haga clic en Agregar.

  3. Seleccione Cargar Especificación OAS.

    Nota:

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

  4. Busque una especificación de OAS en su equipo local y cárguela en NetScaler Console.

Crear una definición de API

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

  1. Vaya a Seguridad > API Security > Definiciones de 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. Haga clic en Agregar. El recurso se agrega a la tabla Recursos agregados . Haga clic en Eliminar para eliminar un recurso de API.

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

Crear o cargar una definición de API