Convalida le specifiche dell'API

Questa pagina si applica a Apigee e Apigee ibridi.

L'hub API fornisce un Linter spettrale integrato (strumento di convalida) che convalida la specifica OpenAPI dell'API. Poco dopo aver aggiunto una specifica OpenAPI alla tua versione API, Lo strumento di convalida (che è abilitato per impostazione predefinita) convalida la specifica e segnala i risultati nella console Google Cloud.

Disabilita convalida delle specifiche

Per impostazione predefinita, il linter è abilitato. Per disattivare il linter, Nella console Google Cloud, vai all'hub API > Impostazioni > Azioni e poi nella sezione Linting disabilita l'opzione Linting.

Guida di stile

Una guida di stile è un insieme di regole in base alle quali l'hub API convalida una specifica OpenAPI. L'hub API utilizza una guida di stile predefinita per convalidare le specifiche OpenAPI. Per le regole predefinite della guida di stile, consulta Regole OpenAPI.

Carica una nuova guida di stile

Console

Per caricare una nuova guida di stile, procedi nel seguente modo:

  1. Crea un nuovo stile estendendo la guida di stile predefinita. Per ulteriori informazioni informazioni, consulta la sezione Creare un set di regole.

  2. Nella console Google Cloud, vai all'hub API > Impostazioni > Azioni.

  3. Nella sezione Linting, fai clic su Carica nuovo documento di stile. Vengono visualizzate le Riquadro Carica documento nuovo stile.
  4. Carica il documento del nuovo stile (creato nel passaggio 1) e fai clic su Salva.

API REST

Per caricare una nuova guida di stile per l'analisi tramite lint, invia una richiesta PATCH alla seguente API:

https://apihub.googleapis.com/v1/projects/PROJECT/locations/LOCATION/plugins/standard-linter/styleGuide?update_mask=contents

Per ulteriori informazioni sull'API, consulta la pagina UpdateStyleGuide.

L'esempio seguente mostra la chiamata API per caricare una guida di stile.

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

Scarica la guida di stile predefinita

Per scaricare la guida di stile predefinita utilizzata dall'hub API per l'analisi tramite lint, segui questi passaggi:

  1. Nella console Google Cloud, vai all'hub API > Impostazioni > Azioni.

  2. Nella sezione Linting, fai clic su Scarica documento di stile originale. Questo scarica il documento di stile predefinito nel sistema locale.

Scarica la guida di stile più recente

Console

Per scaricare la guida di stile attualmente utilizzata dall'hub API per l'analisi tramite lint, segui questi passaggi:

  1. Nella console Google Cloud, vai all'hub API > Impostazioni > Azioni.

  2. Nella sezione Linting, fai clic su Scarica l'ultimo documento di stile. Questo scarica il documento di stile predefinito nel sistema locale.

API REST

Per scaricare la guida di stile attualmente utilizzata dall'hub API per l'analisi tramite lint, invia una richiesta GET alla seguente API:

https://apihub.googleapis.com/v1/projects/PROJECT/locations/LOCATION/plugins/standard-linter/styleGuide:contents

Per ulteriori informazioni sull'API, consulta GetStyleGuide.

L'esempio seguente mostra la chiamata API per scaricare la guida di stile corrente.

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