Validación del origen YAML de OpenAPI
Cómo validar el origen YAML de OpenAPI con las especificaciones de swagger al editar una API.
Acerca de esta tarea
Al configurar una API en el editor de API, puede validar el origen YAML de OpenAPI pulsando . Si se encuentran errores de validación de analizador swagger, se muestra un icono de error que puede pulsar para ver los errores individuales y dónde se producen en el archivo YAML. A continuación, puede arreglar los errores, guardar las actualizaciones y continuar validando el OpenAPI YAML en todo el proceso de configuración de la API.
Nota:
- La validación de OpenAPI no muestra errores de pasarela o política que impidan que la API se transfiera o publique. Este tipo de validación sólo se produce cuando intenta transferir o publicar la API. Para obtener más información, consulte Transferencia de una API o Publicación de una API.
- También puede validar el documento de API utilizando conjuntos de reglas de gobierno . Para obtener más información, consulte Validación de una API o un documento de producto utilizando el servicio de gobierno.
Puede completar esta tarea utilizando la aplicación de interfaz de usuario de API Designer o utilizando la interfaz de usuario de API Manager basada en navegador.
Procedimiento
Para validar el origen YAML de OpenAPI , realice los pasos siguientes.
- Abra la API necesaria para editarla, tal como se describe en Edición de una definición de API de OpenAPI 2.0 o Edición de una definición de API de OpenAPI 3.0.
- Pulse en la barra de menús de la cabecera.
- Si se encuentran errores de validación de analizador Swagger, se muestra un icono de error en la barra de menús de la cabecera, con el número de errores OpenAPI encontrados junto al icono. Por ejemplo,
. - A continuación, puede pulsar el icono de error para ver una lista detallada de los errores y su ubicación en el archivo YAML. Si está en la vista Formulario
, puede pulsar un error individual para ir directamente a la sección de API correspondiente en el formulario. - Después de arreglar el error, pulse Guardar para guardar las actualizaciones y, a continuación, pulse Validar de nuevo.
- Cuando se arreglan todos los errores, la validación devuelve un mensaje de realizado satisfactoriamente. Por ejemplo,
.