Validación de una API o un documento de producto utilizando la CLI del kit de herramientas

Acerca de

El servicio de gobierno en IBM® API Connect se puede utilizar para validar y aplicar políticas de gobierno organizativo y prácticas recomendadas en el proceso de desarrollo de API. La información siguiente proporciona detalles de los mandatos toolkit CLI para ejecutar y gestionar exploraciones de validación en la API o documentos del producto. También puede validar una API o un documento de producto utilizando el Gestor de API y las interfaces de usuario de API Designer . Para obtener más información sobre la exploración de validación, consulte Validación de una API o un documento de producto utilizando el servicio de gobierno.

Validar una única API o documento de producto que se almacena localmente

Validar una o más API o productos almacenados en el servidor de gestión

Esta operación ejecuta una exploración de validación en todos los borradores de API, o en todos los productos, que se listan en la COMPLIANCE_REQUEST_FILE. Puede explorar solo las API, o sólo los productos, en cualquier momento. Las API deben almacenarse como borradores de API en la organización de proveedores.

1. Cree un JSON COMPLIANCE_REQUEST_FILE que especifique los conjuntos de reglas que se van a utilizar durante la validación y la ubicación de las API de borrador o los productos que desea explorar. El archivo sólo puede contener URL para las API, o sólo para los productos; no puede listar los URL de API y de producto en el mismo archivo.
   El ejemplo siguiente muestra un archivo de configuración que especifica dos borradores de API y dos conjuntos de reglas. En el conjunto de reglas spectral-oas , la regla info-contact está inhabilitada y se ignorará durante la validación.

   {
     "apiUrls" : ["https://example.com/api/orgs/768a5f80-177c-4100-b2b6-57ce6c4bf761/drafts/draft-apis/a08898fe-b422-41d3-b058-c3280d632e93","https://example.com/api/orgs/768a5f80-177c-4100-b2b6-57ce6c4bf761/drafts/draft-apis/26692eab-f43b-4af3-985c-2deaa401eb7f"],
     "config" : {
       "rulesets": [
         {
           "rulesetName": "spectral-oas",
           "disabled": ["info-contact"]
         },
         {
           "rulesetName": "spectral-owasp",
           "disabled": []
         }
         ]
    }
   }

   El ejemplo siguiente muestra un archivo de configuración que especifica un documento de producto.

   {
     "productUrls" : ["https://example.com/api/orgs/768a5f80-177c-4100-b2b6-57ce6c4bf761/drafts/draft-product/a07968fe-b422-41d3-b058-c3280d632e93"],
     "config" : {
       "rulesets": [
         {
           "rulesetName": "product-info",
           "disabled": ["subscribe"]
         },
         {
           "rulesetName": "product-rate",
           "disabled": []
         }
         ]
    }
   }

   Donde:

   • apiUrls es una lista delimitada por comas de URL de API. Cada URL especifica la ubicación de los borradores de API en una organización proveedora concreta.
   • productUrls es una lista delimitada por comas de URL de producto. Cada URL especifica la ubicación del documento del producto en una organización proveedora concreta.
   • rulesetName es una lista de conjuntos de reglas que se aplicarán a las API o productos durante la validación.

     Para cada conjunto de reglas de la lista, puede añadir opcionalmente la propiedad disabled con una lista delimitada por comas de reglas a ignorar durante la validación.

2. Inicie sesión en el kit de herramientas como propietario o administrador de la organización de proveedores. Consulte el paso 1 para obtener más detalles.
3. Ejecute el mandato del kit de herramientas de compliance:validate_all en modalidad governance .

   apic --mode governance compliance:validate_all --org <target_org> --server <platform_api_host_name> COMPLIANCE_REQUEST_FILE

   donde:

   • <target_org> es el nombre de la organización de proveedores que es propietaria del catálogo que contiene las API que se van a validar.
   • <platform_api_host_name> es la parte del nombre de host URL del servidor que aloja el Gestor de API (el "servidor de gestión").
     Consejo: Para determinar el nombre de host, puede abrir el Gestor de API en un navegador y copiar el nombre de host de la URL en la barra de direcciones (empezando después de https:// y terminando antes de /manager ).
   • COMPLIANCE_REQUEST_FILE es la ruta y el nombre de archivo del archivo de configuración que enumera los documentos de la API o del producto, y los conjuntos de reglas que se utilizarán durante la validación (por ejemplo, validate-apis.json).