Convalida le specifiche dell'API

Questa pagina si applica a Apigee e Apigee ibridi.

Anteprima - Apigee API hub linting feature

Questa funzionalità è soggetta ai "Termini delle Offerte pre-GA" nella sezione Termini generali del servizio dei Termini specifici dei servizi. Le funzionalità pre-GA sono disponibili "così come sono" e potrebbero avere un supporto limitato. Per saperne di più, consulta le descrizioni della fase di lancio.

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 versione dell'API, lo strumento di convalida (abilitato per impostazione predefinita) convalida la specifica e segnala i risultati nella console Google Cloud.

Nota: in questo argomento, i termini linting e validating vengono utilizzati in modo intercambiabile. Entrambi i termini hanno lo stesso significato.

Disabilita convalida delle specifiche

Per impostazione predefinita, il lint è attivo. 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 della guida di stile predefinite, consulta Regole OpenAPI.

Nota: per aggiungere le tue regole personalizzate, devi creare una nuova guida di stile che espanda quella predefinita. Dopo l'aggiunta di regole personalizzate nella nuova guida di stile, devi caricare la nuova guida di stile nell'hub API.

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, vedi Creare un insieme di regole.
   Nota: un passaggio di convalida eseguito al momento del caricamento genera errore se viene visualizzato un URL nella proprietà extends del set di regole. Ad esempio, questa è una costruzione di proprietà illegale e causerà il fallimento del caricamento: extends: [spectral:oas", "https://mystyle.com/"].

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

3. Nella sezione Linting, fai clic su 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 il linting, 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.

Nota: un passaggio di convalida eseguito sul caricamento genera un errore se un URL viene visualizzato nella proprietà extends del tuo insieme di regole. Ad esempio: si tratta di una costruzione di proprietà illegale e il caricamento non andrà a buon fine: extends: [spectral:oas", "https://mystyle.com/"].

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 il linting, 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 predefinito. 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 allo stile attualmente utilizzata dall'hub API per il linting, 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