Convalida le specifiche dell'API

Questa pagina si applica a Apigee e Apigee ibrido.

L'hub API fornisce un linter spettrale (strumento di convalida) integrato che convalida la specifica OpenAPI dell'API. Subito dopo aver aggiunto una specifica OpenAPI alla versione dell'API, lo strumento di convalida (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 disabilitare il linter, nella console Google Cloud vai alla pagina hub API > Impostazioni > Azioni e disabilita l'opzione Linting nella sezione 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 la sezione 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, consulta la sezione Creare un set di regole.

  2. Nella console Google Cloud, vai alla pagina hub API > Impostazioni > Azioni.

  3. Nella sezione Linting, fai clic su Carica nuovo documento di stile. Viene visualizzato il riquadro Carica nuovo documento di 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 all'API seguente:

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:

  1. Nella console Google Cloud, vai alla pagina hub API > Impostazioni > Azioni.

  2. Nella sezione Linting, fai clic su Scarica documento di stile originale. Questa azione scarica il documento di stile predefinito nel tuo 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 alla pagina hub API > Impostazioni > Azioni.

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

API REST

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

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