Valider les spécifications de l'API

Cette page s'applique à Apigee et à Apigee hybrid.

Preview — Apigee API hub

Cette fonctionnalité est soumise aux "Conditions des offres de pré-DG" dans la section "Conditions d'utilisation générales" des Conditions spécifiques au service. Les fonctionnalités pré-DG sont disponibles "en l'état" et peuvent avoir une assistance limitée. Pour en savoir plus, consultez les descriptions des étapes de lancement.

Le hub d'API fournit un outil de validation Spectral linter intégré qui valide la spécification OpenAPI de votre API. Peu après l'ajout d'une spécification OpenAPI à votre version de l'API, l'outil de validation (activé par défaut) valide la spécification et renvoie les résultats dans la console Google Cloud.

Remarque : Dans cette rubrique, les termes linting et validating sont utilisés de manière interchangeable. Ces deux termes ont la même signification.

Désactiver la validation des spécifications

Par défaut, l'outil lint est activé. Pour désactiver l'outil lint, accédez à la page API Hub > Paramètres > Actions de la console Google Cloud, puis, dans la section Linting, d'sactivez l'option Linting.

Guide de style

Un guide de style est un ensemble de règles par rapport auxquelles le hub d'API valide une spécification OpenAPI. Le hub d'API utilise un guide de style par défaut pour valider les spécifications OpenAPI. Pour connaître les règles du guide de style par défaut, consultez la page Règles OpenAPI.

Remarque : Pour ajouter vos propres règles personnalisées, vous devez créer un guide de style qui étend le guide de style par défaut. Après avoir ajouté vos règles personnalisées dans le nouveau guide de style, vous devez importer le nouveau guide de style dans le hub d'API.

Importer un nouveau guide de style

Console

Pour importer un nouveau guide de style, procédez comme suit:

1. Créez un style en étendant le guide de style par défaut. Pour plus d'informations, consultez la section Créer un ensemble de règles.
   Remarque : Une étape de validation effectuée lors de l'importation génère une erreur si une URL apparaît dans la propriété extends de votre ensemble de règles. Par exemple, il s'agit d'une construction de propriété illégale qui entraînera l'échec de l'importation : extends: [spectral:oas", "https://mystyle.com/"].

2. Dans la console Google Cloud, accédez à la page API Hub > Paramètres > Actions.

3. Dans la section Amorçage, cliquez sur Importer un nouveau document de style. Le volet Importer un nouveau document de style s'affiche.
4. Importez le document de style (créé à l'étape 1), puis cliquez sur Save (Enregistrer).

API REST

Pour importer un nouveau guide de style pour l'analyse lint, envoyez une requête PATCH à l'API suivante:

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

Pour en savoir plus sur l'API, consultez la section UpdateStyleGuide.

Remarque : Une étape de validation effectuée lors de l'importation génère une erreur si une URL apparaît dans la propriété extends de votre ensemble de règles. Par exemple, il s'agit d'une construction de propriété illégale qui entraînera l'échec de l'importation : extends: [spectral:oas", "https://mystyle.com/"].

L'exemple suivant montre l'appel d'API permettant d'importer un guide de style.

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  

Télécharger le guide de style par défaut

Pour télécharger le guide de style par défaut utilisé par le hub d'API pour l'analyse lint, procédez comme suit:

1. Dans la console Google Cloud, accédez à la page API Hub > Paramètres > Actions.

2. Dans la section Intégration, cliquez sur Télécharger le document de style d'origine. Le document de style par défaut est alors téléchargé sur votre système local.

Télécharger le dernier guide de style

Console

Pour télécharger le guide de style actuellement utilisé par le hub d'API pour l'analyse lint, procédez comme suit:

1. Dans la console Google Cloud, accédez à la page API Hub > Paramètres > Actions.

2. Dans la section Linting, cliquez sur Télécharger le dernier document de style. Le document de style par défaut est alors téléchargé sur votre système local.

API REST

Pour télécharger le guide de style actuellement utilisé par le hub d'API pour l'analyse lint, envoyez une requête GET à l'API suivante:

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

Pour en savoir plus sur l'API, consultez la section GetStyleGuide.

L'exemple suivant montre l'appel d'API pour télécharger le guide de style actuel.

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