Esta página se aplica a Apigee y Apigee Hybrid.
El centro de APIs proporciona un linter espectral (validador) integrado que valida la especificación de OpenAPI de la API. Poco después de agregar una especificación de OpenAPI a tu versión de API, el validador (que está habilitado de forma predeterminada) valida la especificación y, luego, informa los resultados en la consola de Google Cloud.
Inhabilita la validación de la especificación
De forma predeterminada, linter está habilitado. Para inhabilitar linter, en la consola de Google Cloud, ve a la página Centro de APIs > Configuración > Acciones y, luego, en la sección Análisis con lint, inhabilita la opción Análisis con lint.
Guía de estilo
Una guía de estilo es un conjunto de reglas con las que el centro de API valida una especificación de OpenAPI. El centro de APIs usa una guía de estilo predeterminada para validar las especificaciones de OpenAPI. Para ver las reglas de la guía de estilo predeterminadas, consulta Reglas de OpenAPI.
Sube una nueva guía de estilo
Console
Para subir una guía de estilo nueva, sigue estos pasos:
- Para crear un diseño nuevo, extiende la guía de estilo predeterminada. Para obtener más información, consulta Crea un conjunto de reglas.
En la consola de Google Cloud, ve a la página Centro de APIs > Configuración > Acciones.
- En la sección Análisis con lint, haz clic en Subir documento de estilo nuevo. Esto muestra el panel Subir documento de estilo nuevo.
- Sube el documento de estilo nuevo (creado en el paso 1) y, luego, haz clic en Guardar.
API de REST
Para subir una nueva guía de estilo para el análisis con lint, envía una solicitud PATCH a la siguiente API:
https://apihub.googleapis.com/v1/projects/PROJECT/locations/LOCATION/plugins/standard-linter/styleGuide?update_mask=contents
Para obtener más información sobre la API, consulta UpdateStyleGuide.
En el siguiente ejemplo, se muestra la llamada a la API para subir una guía de estilo.
curl \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{"name":"projects/test-project-1/locations/us-central1/plugins/standard-linter/styleGuide",
"contents":{ "contents": "ZXh0ZW5kczogWyJzcGVjdHJhbDpvYXMiXQo=",
"mimeType": "text/yaml"}}' \
-X PATCH \
https://apihub.googleapis.com/v1/projects/test-project-1/locations/us-central1/plugins/standard-linter/styleGuide?update_mask=contents
Descarga la guía de estilo predeterminada
Para descargar la guía de estilo predeterminada que usa el centro de API para el análisis con lint, sigue estos pasos:
En la consola de Google Cloud, ve a la página Centro de APIs > Configuración > Acciones.
- En la sección Análisis con lint, haz clic en Descargar documento de estilo original. Así se descarga el documento de estilo predeterminado a tu sistema local.
Descarga la guía de estilo más reciente
Console
Si deseas descargar la guía de estilo que usa el centro de APIs para el análisis con lint, sigue estos pasos:
En la consola de Google Cloud, ve a la página Centro de APIs > Configuración > Acciones.
- En la sección Análisis con lint, haz clic en Descargar el documento de estilo más reciente. Así se descarga el documento de estilo predeterminado a tu sistema local.
API de REST
Para descargar la guía de estilo que usa el concentrador de APIs para el análisis con lint, envía una solicitud GET a la siguiente API:
https://apihub.googleapis.com/v1/projects/PROJECT/locations/LOCATION/plugins/standard-linter/styleGuide:contents
Para obtener más información sobre la API, consulta GetStyleGuide.
En el siguiente ejemplo, se muestra la llamada a la API para descargar la guía de estilo actual.
curl -X \ GET -H "Authorization: Bearer $(gcloud auth print-access-token)" \ https://apihub.googleapis.com/v1/projects/test-project-1/locations/us-central1/plugins/standard-linter/styleGuide:contents