Documentación de productos
ADC
14.1 - Current Release 13.1 13.0 12.1
Ver PDF

Especificación de API de importación

June 13, 2024
Contribución de: 
C

La especificación de la API define el diseño de una API, incluidos los puntos finales, los métodos, los parámetros y los formatos de datos. La capacidad de especificación de API de importación le permite importar la especificación de API abierta, que generalmente se usa para describir la API REST. Cuando el Web App Firewall realiza una comprobación de validación de la solicitud de un usuario para un servicio web basado en API, valida la solicitud con respecto al esquema especificado en el archivo de especificación de API para ese servicio web. NetScaler admite validaciones de esquemas para una API REST con la carga útil como JSON de la aplicación y ProtoBuf para las solicitudes de API gRPC.

NetScaler admite los siguientes formatos de especificación:

  • API abierta: Swagger 2.0, OAS 3.0.3.1
  • ProtoBuf - v3 y v2

Administrar archivos de especificación de API

Puede validar el tráfico de la API entrante comparándolo con la especificación de la API importada asignándolo a un perfil y configurando una regla de relajación para bloquear o permitir el tráfico. La importación de una especificación de API consta de dos pasos:

  1. Importar la especificación de la API: importe una especificación de la API a NetScaler a través de una URL o desde el sistema.
  2. Agregue la especificación de API a NetScaler: al agregar una especificación de API a NetScaler, el archivo se valida, se convierte a un formato interno y se crea una entidad de especificación de API. La entidad de especificación de API creada se utilizará en las expresiones de directivas y en los perfiles de Web App Firewall.

Nota:

Asegúrese de que los archivos de especificación Open API Swagger 2.0, OAS 3.0 y 3.1 cargados no contengan ninguna referencia a archivos externos. Si necesita usar detalles de un archivo externo, consolide la información en un solo archivo con herramientas de código abierto y, a continuación, cárguelo.

Administrar archivos de especificación de API mediante la CLI

Los siguientes parámetros se utilizan en los comandos de la CLI:

  • Nombre: nombre del archivo de especificación de API que se carga.
  • Origen: URL (protocolo, host, ruta y nombre) de la ubicación en la que se almacena el archivo de especificaciones importado.
  • Nombre de especificación: E l nombre de la entidad que se crea a partir de la especificación de API cargada.
  • Tipo: formato de entrada de la especificación de la API. Valor predeterminado: OAS

Para importar un archivo de especificación de API, escriba:

import api specFile <name> <src>

Ejemplo:
import apispec testapispec.json http://www.example.com/testapispec.json

Para agregar un archivo de especificación de API, escriba:

add api spec <Name> -File <string> -Type <string>

Ejemplo:
add api spec testapispec -File testapispec.json -Type OAS

Para actualizar un archivo de especificaciones de API, importe un nuevo archivo de especificaciones que deba actualizarse.

En la línea de comandos, escriba:

update api spec <specName> -File <string> -Type <string>

Ejemplo:
update api spec testapispec -File testapispec.json -Type OAS

Nota:

Si no se especifica el atributo type, OAS es el tipo predeterminado.

Para ver todos los puntos finales, escriba:

show api spec <specName>

Ejemplo:

show api spec testapispec

Para eliminar la especificación de la API, escriba:

rm api spec <specName>

Ejemplo:

rm api spec testapispec

Nota:

Antes de eliminar la especificación de la API, asegúrese de que ningún perfil o directiva la utilice.

Gestione los archivos de especificación de API mediante la GUI

  1. Vaya a Seguridad > NetScaler Web App Firewall > Importaciones.
  2. En la página Importaciones, seleccione la ficha Página de importación de especificaciones de API y, a continuación, haga clic en Agregar.
  3. En la página Importar objetos de especificación de API, seleccione una de las siguientes opciones para el parámetro Importar desde :
    1. URL: URL de un sitio web al que puede acceder el dispositivo.
    2. Archivo: archivo que se encuentra en un disco duro local o en red o en otro dispositivo de almacenamiento.
  4. Haga clic en Continuar.
  5. En la página de objetos de importación de especificaciones de API, introduzca los siguientes detalles:
    1. Nombre de especificación de API: el nombre de la entidad que se crea a partir de la especificación de API cargada. Nota: Tanto el nombre del archivo de la API como el nombre de la especificación de la API introducidos deben ser iguales.

    2. Tipo de especificación de API: seleccione el tipo de especificación.

      Tipos: REST (OpenAPI/Swagger) y gRPC (PROTO).

      Tipo predeterminado: REST (OpenAPI/Swagger)

    3. Haga clic en Listo.

La entidad recién agregada aparece en la página Importaciones, en la ficha Página de importación de especificaciones de API.

Ver estadísticas de especificación de API y dispositivos de punto final de API

Puede ver las siguientes estadísticas con respecto a todas las especificaciones de API y dispositivos de punto final de API:

  • Coincidencias de especificaciones de API: Solicitudes que coinciden con cualquier dispositivo de punto final de la especificación de API.
  • Validaciones correctas de la especificación de API: Solicitudes que coinciden con cualquier dispositivo de punto final de la especificación de API y que cumplen con el esquema de la API.
  • Solicitudes no coincidentes de especificación de API: Solicitudes que no coinciden con ningún dispositivo de punto final de la especificación de API.
  • Coincidencias de dispositivo de punto final de API: Solicitudes que coinciden con un dispositivo de punto final específico.
  • Validaciones correctas de dispositivos de punto final de API: Solicitudes que coinciden con un dispositivo de punto final específico y que cumplen con el esquema de la API.

Ver estadísticas de especificaciones de API y de dispositivos de punto final de API mediante la CLI

En la línea de comandos, escriba:

stat apispec <apispec name>

Ejemplo

stat apispec testapispec

Ver estadísticas de especificaciones de API y dispositivos de punto final de API mediante la GUI

  1. Vaya a Seguridad > NetScaler Web App Firewall > Importaciones.

  2. En la página Importaciones, seleccione la ficha Importación de especificaciones de API y, a continuación, haga clic en Estadísticas.

    Se muestra el resumen de las especificaciones de API.

  3. Para ver el resumen de dispositivos de punto final, haga clic en cualquiera de las especificaciones de API.

    Se muestra el resumen de dispositivos de punto final de API para la especificación de API seleccionada.

Especificación de API de importación
June 13, 2024
Contribución de: 
C
June 13, 2024
Contribución de: 
C

En este artículo

Comentarios sobre el sitio | Your privacy choices footer linkSus opciones de privacidad | Condiciones legales y de privacidad | Preferencias de cookies | Parámetros de consentimiento | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.