Documenter les API avec SmartDocs

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X.
en savoir plus

SmartDocs vous permet de documenter vos API sur le portail des développeurs Drupal 7 de manière à rendre la documentation des API entièrement interactive. Grâce à la documentation interactive, les utilisateurs du portail peuvent:

  • En savoir plus sur vos API
  • Envoyer une requête en direct à votre API
  • Afficher une réponse en direct renvoyée par l'API

En créant une documentation interactive sur vos API, vous aidez l'utilisateur du portail à apprendre, tester et évaluer facilement vos API.

L'API de gestion Edge est une API RESTful qui vous permet d'accéder aux services d'API à l'aide de n'importe quel client HTTP. Apigee utilise SmartDocs pour créer une documentation interactive pour l'API de gestion Edge. Pour consulter la documentation de l'API, cliquez ici.

Exemple de portail SmartDocs

Pour utiliser SmartDocs, vous devez disposer d'un portail de services pour les développeurs Apigee. Pour en savoir plus, consultez la page Créer un portail des développeurs.

Sur la page d'accueil de votre portail des développeurs, cliquez sur API dans la barre de navigation supérieure pour afficher la page de documentation de l'API.

Deux API sont documentées sur le portail: Hello World et Pet Store Example.

L'API Hello World a été créée à partir de la spécification OpenAPI cible fictive mocktarget.yaml. Pour en savoir plus, consultez la page https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld/openapi.

L'API Pet Store Example a été créée à partir de la version de démonstration classique des animaleries.

Découvrez l'API Hello World:

  1. Cliquez sur API Hello World. La page récapitulative de l'API Hello World s'affiche:
  2. Cliquez sur Afficher l'affirmation concernant l'API. Les SmartDocs pour cette ressource s'affichent:
  3. Cliquez sur Envoyer cette demande.
  4. Consultez la réponse renvoyée :
    HTTP/1.1 200 OK
    Connection:
    keep-alive
    Content-Length:
    18
    Content-Type:
    text/html; charset=utf-8
    Date:
    Tue, 21 Jun 2016 21:49:32 GMT
    ETag:
    W/"12-Jb9QP1bUxNSmZkxQGt5KLQ"
    X-Powered-By:
    Apigee
    <H2>I <3 APIs</H2>
    
  5. Cliquez sur l'onglet Request (Requête) pour afficher la requête ou sur l'onglet cURL pour afficher l'appel cURL correspondant.

Comment documenter vos API à l'aide de SmartDocs

SmartDocs représente vos API à l'aide d'un model, qui contient toutes les informations sur vos API. Le portail extrait des informations sur vos API du modèle pour afficher les pages de documentation du portail en tant que nœuds Drupal, où chaque nœud Drupal correspond à une page de documentation sur le portail.

Pour utiliser SmartDocs, procédez comme suit:

  1. Configurez le module Drupal SmartDocs sur le portail.
  2. Créez un modèle SmartDocs.
  3. Ajoutez des API au modèle à partir d'un fichier WADL, d'une spécification OpenAPI (anciennement Swagger) ou manuellement.
  4. Effectuez le rendu du modèle sous la forme d'une collection de nœuds Drupal. Chaque nœud Drupal contient des informations sur une seule API. Par exemple, si une ressource de l'API est compatible avec les requêtes POST et PUT, SmartDocs crée un nœud Drupal distinct pour les requêtes POST et PUT.
  5. Publiez les nœuds Drupal. Une fois votre API publiée, les utilisateurs de votre portail peuvent la voir et interagir avec elle.
  6. Modifiez les nœuds Drupal, avant ou après leur publication. Vous pouvez modifier les nœuds Drupal à l'aide de l'éditeur Drupal ou en modifiant le fichier WADL d'origine ou la spécification OpenAPI. Lorsque vous avez terminé de modifier le fichier WADL ou la spécification OpenAPI, réimportez-le dans le modèle en tant que nouvelle révision, puis effectuez le rendu et publiez vos modifications.
  7. Activez le protocole TLS. Étant donné que SmartDocs peut envoyer des identifiants d'authentification à votre backend lors de l'envoi d'une requête à vos API, vous devez activer le protocole TLS sur votre portail pour vous assurer que ces identifiants sont sécurisés. Dans les environnements de production et de test du portail, Apigee fournit le certificat TLS requis pour effectuer des requêtes https://. Toutefois, avant de mettre en service votre portail, vous devez obtenir votre propre certificat TLS et activer le protocole TLS. Pour en savoir plus, consultez la section Utiliser TLS sur le portail.

À propos des modèles et modèles SmartDoc

Lorsque vous créez un modèle sur votre portail, il est en fait stocké dans votre organisation Edge, et non dans Drupal. Un modèle est un grand bloc de code JSON portant un nom interne (tel que "my-smartdocs-api") et définit la structure d'une API. En revanche, votre portail affiche le modèle en HTML et fournit une interface de modification pour celui-ci. Toutes les mises à jour de l'API dans le portail sont automatiquement renvoyées au modèle source.

Stocké dans l'organisation

Stocké dans Drupal

ajustables

templates

Nœuds Drupal avec fonctionnalité de modification

Supposons que votre organisation dispose de plusieurs portails (développement, préproduction et production, par exemple). Dans Pantheon, vous déplacez un portail d'un environnement à un autre. Chaque instance du portail semble contenir son propre modèle, mais elles font toutes référence au modèle source. Si vous modifiez l'API en développement, le modèle est mis à jour et les modifications apparaissent en production. De même, si vous supprimez un modèle en développement, la source est supprimée et n'est plus disponible en production.

Les modèles contrôlent l'apparence de vos SmartDocs, et ces modèles (gérés par des poignées et des fichiers CSS) sont stockés avec chaque instance de portail. Ainsi, chaque portail peut théoriquement utiliser un modèle unique pour chaque modèle. Cependant, l'un des avantages du framework de rendu est qu'un modèle par défaut (Apigee par défaut ou que vous fournissez) est automatiquement appliqué à chaque modèle.

Le schéma suivant illustre la relation entre les modèles et les portails. Les flèches vertes représentent la synchronisation automatique.

La commande cURL suivante répertorie tous les modèles de votre organisation:

curl -v https://api.enterprise.apigee.com/v1/o/{your_org}/apimodels/ -u edge_org_admin@example.com

Configurer le module SmartDocs

Apigee a implémenté SmartDocs en tant que module Drupal personnalisé. Utilisez la procédure suivante pour configurer le module SmartDocs.

Pour configurer le module SmartDocs:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Modules dans le menu d'administration de Drupal. La liste de tous les modules Drupal installés s'affiche.
  3. Activez le module SmartDocs.
  4. Enregistrez la configuration.
  5. Sélectionnez Modules dans le menu d'administration Drupal.
  6. Sélectionnez SmartDocs -> Permissions et assurez-vous que l'option "Effectuer des tâches d'administration pour le module SmartDocs" est activée pour le rôle "Administrateur".
  7. Sélectionnez Configuration > Portail de développement dans le menu d'administration de Drupal.
  8. Définissez les paramètres Connection Timeout (Délai avant expiration de la connexion) et Request Timeout (Délai avant expiration de la requête) sur 16 secondes.
  9. Enregistrez la configuration.
  10. Configurez les paramètres d'URL :
    1. Sélectionnez Configuration > Recherche et métadonnées > Alias d'URL > Paramètres dans le menu Drupal.
    2. Définissez les valeurs Longueur maximale de l'alias et Longueur maximale des composants sur 255.
    3. Développez la section Ponctuation.
    4. Pour les paramètres Accroche gauche ({) et Accroche droite (}), sélectionnez Aucune action (ne pas remplacer).
    5. Cliquez sur Enregistrer la configuration.
  11. Si votre portail des développeurs est exposé aux utilisateurs d'un réseau interne sans accès à Internet, ou si un sous-ensemble de vos API se trouve sur un réseau privé, configurez l'URL du proxy de l'API SmartDocs comme suit :
    1. Sélectionnez Configuration > SmartDocs dans le menu d'administration de Drupal.
    2. Développez la section Paramètres avancés.
    3. Mettez à jour le champ URL du proxy SmartDocs comme suit : <host>/smartdocs/v1/sendrequest.
      L'aide intégrée doit fournir la valeur requise pour votre environnement. Par exemple:
      https://api-us-east-1-enterprise.apigee.com/smartdocs/v1/sendrequest

      Ce champ est défini par défaut sur https://apiconsole-prod.apigee.net/smartdocs/v1/sendrequest
    4. Cliquez sur Enregistrer la configuration.

Créer un modèle

Un modèle contient toutes les informations sur la représentation de votre API. Vous pouvez définir plusieurs modèles sur le portail pour prendre en charge différentes API ou regrouper toutes vos API dans un seul modèle.

Chaque modèle spécifie un nom interne unique qui définit également l'URL de base des nœuds Drupal générés. L'URL de chaque nœud Drupal se présente sous la forme suivante:

http://<drupalBasePath>/<internalName>/apis/<httpMethod>/<resourcePath>

où :

  • drupalBasePath: URL de base de votre portail.
  • internalName: nom interne du modèle.
  • httpMethod : méthode HTTP de l'API, telle que "get", "put", "post" ou "delete".
  • resourcePath: chemin d'accès à la ressource.

Par exemple, si vous spécifiez "mymodel" comme nom interne, l'URL du nœud Drupal généré pour une requête GET adressée à une ressource nommée "/books" est la suivante:

http://prod-myco.devportal.apigee.com/mymodel/apis/get/books

Créer un modèle

Lorsque vous créez un modèle, il est stocké dans votre organisation Edge en tant que source de la structure d'API. Pour en savoir plus, consultez la section À propos des modèles et des modèles SmartDoc.

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Content > SmartDocs (Contenu > SmartDocs) dans le menu d'administration de Drupal.
  3. Sélectionnez Nouveau modèle en haut de la page.
  4. Renseignez les champs suivants :
    • Nom: nom du modèle qui sera affiché sur le site.
    • Nom interne: lorsque vous saisissez le nom, le nom interne s'affiche. Nom interne du modèle, qui doit être unique parmi tous les modèles. Le nom interne ne doit contenir que des lettres minuscules, des chiffres et des traits d'union, sans espaces. Sélectionnez Modifier pour modifier ce nom.
    • Description: description du modèle.
  5. Sélectionnez Créer un modèle.

Une fois le modèle créé, vous êtes redirigé vers sa page. À partir de là, vous pouvez utiliser la liste déroulante Opérations bx pour:

  • Importez un fichier WADL décrivant votre API, ou spécifiez l'URL d'une spécification OpenAPI qui décrit votre API.
  • Ajouter une révision au modèle
  • Modifier les paramètres du modèle, y compris les feuilles de style utilisées par le modèle
  • Exportez le modèle dans un fichier.
  • Supprimez le modèle.

Ajouter des API à un modèle

Pour ajouter des API à un modèle:

  • Importer un fichier WADL contenant la définition de l'API
  • Importer une spécification OpenAPI (OpenAPI 2.0 ou 1.2)
  • Créer manuellement des ressources et des méthodes

Vous pouvez également importer un fichier JSON SmartDocs dans un modèle. Ce fichier est généralement créé en exportant un modèle existant, en le modifiant, puis en important les mises à jour. Pour en savoir plus, consultez la section Exporter et importer un modèle ci-dessous.

Vidéo:regardez une courte vidéo pour savoir comment ajouter des API à un modèle SmartDocs en important une spécification OpenAPI.

Importer un WADL

Une fois que vous avez créé un modèle, importez un fichier WADL décrivant votre API. Chaque fois que vous importez un fichier WADL, vous créez automatiquement une révision du modèle.

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Content > SmartDocs (Contenu > SmartDocs) dans le menu d'administration de Drupal.
  3. Sélectionnez le modèle que vous souhaitez mettre à jour.
  4. Sous Opérations, sélectionnez Importer.
  5. Sélectionnez WADL dans la liste déroulante Choose Format (Sélectionner un format) de la page d'importation SmartDocs.
  6. Sélectionnez Fichier ou URL dans le menu déroulant Type d'importation.
    1. Si vous sélectionnez Fichier, accédez au fichier WADL.
    2. Si vous sélectionnez URL, spécifiez l'URL du fichier WADL.
  7. Cliquez sur Import (Importer) pour l'importer dans le modèle. Vous pouvez maintenant effectuer le rendu du modèle.
  8. Vous êtes redirigé vers la page d'informations du modèle où vous pouvez maintenant afficher le modèle.

Importer une spécification OpenAPI

Une fois que vous avez créé un modèle, vous pouvez importer une spécification OpenAPI (anciennement Swagger). Edge est compatible avec les versions 1.2 et 2.0 d'OpenAPI.

OpenAPI utilise des fichiers contenant des objets JSON pour décrire une API. Chaque fois que vous importez une spécification OpenAPI, vous créez automatiquement une révision du modèle.

Pour importer une spécification OpenAPI:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Contenu > SmartDocs dans le menu d'administration Drupal.
  3. Sélectionnez le modèle que vous souhaitez mettre à jour.
  4. Sous Opérations, sélectionnez Importer.
  5. Sélectionnez Swagger JSON (JSON Swagger) ou Swagger YAML (YAML Swagger) dans le menu déroulant Choose Format (Sélectionner un format) de la page d'importation SmartDocs.
  6. Sélectionnez File (Fichier) ou URL dans la liste déroulante Upload Type (Type d'importation) (vous devez sélectionner URL pour OpenAPI 1.2).
    1. Si vous sélectionnez File (Fichier), accédez à la spécification OpenAPI.
    2. Si vous sélectionnez URL, spécifiez l'URL de la spécification OpenAPI.
  7. Cliquez sur Import (Importer) pour l'importer dans le modèle.
  8. Vous êtes redirigé vers la page d'informations du modèle où vous pouvez maintenant afficher le modèle.

Créer des ressources et des méthodes manuellement

Si vous n'avez pas de fichier WADL ni de spécification OpenAPI représentant votre API, vous pouvez ajouter manuellement des API à votre modèle. En outre, si vous utilisez un fichier WADL ou une spécification OpenAPI pour créer votre modèle, vous pouvez suivre cette procédure pour modifier vos API (y compris en ajouter de nouvelles) après l'importation.

Pour ajouter manuellement une API:

  1. Créez une révision du modèle.

    Lorsque vous créez la révision, vous spécifiez le chemin de base unique de toutes les API du modèle, ce qui signifie que toutes les API d'un modèle partagent le même chemin de base. Par exemple, spécifiez le chemin de base comme suit:

    https://myCompany.com/v1

    Lorsque vous ajoutez des ressources au modèle, elles étendent le chemin de base.
  2. Définissez une ou plusieurs ressources pour le modèle. Le chemin d'accès à la ressource est associé au chemin de base de la révision du modèle afin de spécifier l'URL complète de la ressource. Par exemple, si votre ressource définit un chemin d'accès "/login", l'URL complète de la ressource est:

    https://myCompany.com/v1/login
  3. Définissez une ou plusieurs méthodes pour chaque ressource. Une méthode spécifie le verbe HTTP pouvant être appelé sur une ressource. Par exemple, pour la ressource "/login", vous pouvez utiliser POST pour la connexion et DELETE pour la déconnexion. Cette ressource n'accepte pas les autres verbes HTTP, tels que PUT ou GET. Par conséquent, définissez deux méthodes pour la ressource, une pour la méthode POST et une pour la méthode DELETE.

    La méthode utilise l'URL de la ressource de sa ressource parente. Par conséquent, toutes les méthodes ayant la même URL sont définies sous une seule ressource dans SmartDocs.

Règle d'ordre général :

  • Créez un modèle SmartDocs différent pour chaque chemin de base unique dans votre API.
  • Définissez une ressource SmartDocs différente pour chaque ressource unique de votre API.
  • Définissez une méthode SmartDocs différente pour chaque verbe HTTP accepté par une ressource.

Créer une révision d'un modèle

Vous ne pouvez ajouter une ressource qu'à une révision existante d'un modèle. Si le modèle comporte déjà une révision, vous pouvez ajouter votre ressource. Si le modèle est nouveau et ne comporte aucune révision, créez une révision.

Pour créer une révision d'un modèle:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Contenu > SmartDocs dans le menu d'administration de Drupal.
  3. Pour le modèle que vous souhaitez mettre à jour, sélectionnez Ajouter une révision sous Opérations.
  4. Sur la page Ajouter une révision de l'API, saisissez les informations suivantes :
    • Display Name (Nom à afficher) : nom de la révision tel qu'il apparaît dans le portail.
    • ID de version: identifiant court de la révision.
    • Description: description de la révision.
    • URL de base: URL de base de toutes les API de la révision du modèle. Un modèle peut utiliser différentes URL de base pour chaque révision. Par exemple, vous incluez un indicateur de version dans l'URL de base. Pour la première révision du modèle, l'URL de base est:
      https://myCompany.com/v1
      Pour la prochaine révision, l'URL de base pourrait être:
      https://myCompany.com/v2
  5. Sélectionnez Ajouter une révision. Vous êtes redirigé vers la page de révision du modèle. Vous pouvez maintenant définir des ressources sur le modèle.

Définir une ressource

Une ressource spécifie l'URL complète d'une API. Lorsque vous définissez une ressource, vous spécifiez son chemin d'accès, qui est combiné à l'URL de base dans la révision du modèle pour créer l'URL complète de la ressource.

Pour définir une ressource:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Contenu > SmartDocs dans le menu d'administration de Drupal.
  3. Pour le modèle que vous souhaitez mettre à jour, sous Opérations, sélectionnez Révisions de l'API pour afficher toutes les révisions d'un modèle.
  4. Sélectionnez une révision à modifier.
  5. Sur la page de révision, sélectionnez Ajouter une ressource dans le menu déroulant.
  6. Sur la page Ajouter une ressource, saisissez les informations suivantes :
    • Display Name (Nom à afficher) : nom de la ressource.
    • Path (Chemin d'accès) : chemin d'accès à la ressource commençant par "/". La valeur de Path est combinée à l'URL de base de la révision du modèle pour créer l'URL complète de la ressource.
    • Description: description de la ressource.
    • Paramètres: vous pouvez éventuellement saisir l'objet JSON définissant chaque paramètre de la ressource. Ces paramètres sont décrits ci-dessous.
  7. Sélectionnez Ajouter une ressource. Vous êtes redirigé vers la page du modèle. Vous pouvez maintenant définir des méthodes sur la ressource.

Vous pouvez éventuellement ajouter des paramètres à la ressource, tels que des paramètres de modèle, de requête et d'en-tête. Tous les paramètres de ressource sont hérités par les méthodes définies sur cette ressource. Par conséquent, si vous définissez un paramètre de requête sur la ressource, toutes les méthodes ajoutées à cette ressource doivent être compatibles avec ce paramètre.

Vous pouvez également définir des paramètres au niveau d'une méthode. Par exemple, une méthode POST peut prendre en charge des paramètres de requête non pris en charge par une méthode DELETE. Par conséquent, vous devez ajouter tous les paramètres spécifiques à une méthode lorsque vous la définissez, comme décrit ci-dessous.

L'image suivante montre une page SmartDocs pour l'API Apigee Validate ou Reconciliation App, chaque type de paramètre est mis en surbrillance:

Chaque type de paramètre est défini par un objet JSON:

Type

Objet JSON

Remarques

Template

{
"dataType": "string",
"defaultValue": "",
"description": "Le nom de l'organisation",
"name": "org_name",
"required": true,
"type": "TEMPLATE"
}

Les paramètres de modèle sont toujours obligatoires. Par conséquent, définissez required sur true et omettez la valeur sur defaultValue.

La valeur de description apparaît dans un pop-up lorsque l'utilisateur pointe sur l'URL dans une page SmartDocs.

Requête

{
"dataType": "string",
"defaultValue": "",
"description": "L'emplacement.",
"name": "w",
"required": true,
"type": "QUERY"
}

Les paramètres de requête obligatoires peuvent tout de même spécifier une valeur defaultValue, mais ce n'est souvent pas le cas.

Pour les paramètres de requête facultatifs, définissez required sur false et spécifiez une valeur sur defaultValue.

En-tête

{
"dataType": "string",
"defaultValue": "application/json",
"description": "Spécifier comme <code>application/json</code>.",
"name": "Content-Type",
"required": true,
"type": "HEADER"
}

Notez que vous pouvez utiliser des balises HTML dans la description.

Un paramètre de modèle définit une variable dans le chemin d'accès à la ressource. Par exemple, vous définissez deux paramètres de modèle sur la ressource. Notez que chaque définition de paramètre dans le tableau de paramètres est séparée par une virgule:

[
 {
  "dataType": "string",
  "defaultValue": "",
  "description": "Mention the organization name.",
  "name": "org_name",
  "required": true,
  "type": "TEMPLATE"
 },
 {
  "dataType": "string",
  "defaultValue": "",
  "description": "Mention the user email.",
  "name": "developer_email",
  "required": true,
  "type": "TEMPLATE"
 }
]

Vous pouvez ensuite utiliser les paramètres du modèle dans la définition du chemin d'accès à la ressource, entre "{}". Par exemple, définissez le chemin d'accès sur:

/login/{org_name}/{developer_email}

Sur la page de l'API SmartDocs, l'utilisateur doit modifier l'URL en indiquant la partie org_name et developer_email de l'URL avant de pouvoir envoyer une demande.

Définir une méthode

Définissez une ou plusieurs méthodes pour chaque ressource. La définition de la méthode spécifie un verbe HTTP pouvant être appelé sur la ressource. Une ou plusieurs méthodes peuvent être définies pour une ressource.

Lorsque vous définissez la méthode, spécifiez les paramètres qu'elle utilise, y compris les paramètres de requête et d'en-tête. Pour en savoir plus sur l'ajout de paramètres à une méthode, consultez la description ci-dessus.

L'image suivante montre une page SmartDocs existante pour l'API Create Developer d'Apigee, chaque zone de la page étant mise en surbrillance avec la valeur correspondante que vous avez définie lors de la définition d'une méthode:

L'image suivante montre la même page, mais avec la description du corps de la requête sélectionnée:

Pour définir une méthode:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Contenu > SmartDocs dans le menu d'administration de Drupal.
  3. Pour le modèle que vous souhaitez mettre à jour, sous Opérations, sélectionnez Révisions de l'API pour afficher toutes les révisions d'un modèle.
  4. Sélectionnez une révision à modifier.
  5. Sur la page de révision, sélectionnez Add Method (Ajouter une méthode) dans le menu déroulant de l'une des ressources.
  6. Sur la page Edit Method (Modifier la méthode), saisissez les informations suivantes :
    • Display Name (Nom à afficher) : nom de l'API, qui devient également le titre de la page Drupal de l'API.
    • Description: décrivez l'API.
    • Méthode Verbe: type de verbe HTTP.
    • Schémas de sécurité: spécifiez le mode d'authentification de la méthode, le cas échéant. Pour en savoir plus, consultez la section Configurer le type d'authentification SmartDocs.
    • Type de contenu: type de contenu de la requête et de la réponse. Consultez la section ci-dessous pour configurer différentes méthodes d'authentification.
    • Parameters (Paramètres) : (facultatif) tous les paramètres de requête ou d'en-tête de la méthode. Pour en savoir plus, consultez la description ci-dessus pour savoir comment ajouter un paramètre à une ressource.
    • Documentation du corps de la requête: (facultatif) décrivez le corps de la requête. Les méthodes POST et PUT utilisent un corps de requête. Vous pouvez utiliser cette zone pour la décrire. Si vous omettez cette valeur, le lien Description sous Corps de la requête est omis de la page SmartDocs générée.
    • Exemple de corps de requête: (facultatif) affiche un exemple de corps de requête, généralement sous forme d'objet JSON ou XML. Pour les verbes POST et PUT, l'exemple de corps de la requête est transmis dans le cadre de chaque requête. Les utilisateurs de la page SmartDocs modifient cet exemple avant d'envoyer une requête à l'API. Si vous omettez cette valeur, le lien Value (Valeur) sous Request Body (Corps de la requête) est omis de la page SmartDocs générée.
    • Tags: tableau de tags associés à l'API. SmartDocs utilise des tags pour regrouper des API similaires. Par exemple, vous pouvez appliquer le tag "Statistiques" à toutes les API relatives aux statistiques. Vous pouvez regrouper des API de différentes ressources sous un seul tag si elles utilisent toutes le même tag.
  7. Sélectionnez Add Method (Ajouter une méthode). Vous êtes redirigé vers la page du modèle. Vous pouvez maintenant afficher et publier votre méthode.

Afficher un modèle

Une fois que vous avez ajouté des API à un modèle, vous pouvez effectuer son rendu. L'affichage convertit la description de l'API par le modèle en nœuds Drupal. Une fois l'affichage terminé, vous disposez d'un seul nœud Drupal pour chaque API, chaque nœud Drupal correspondant à une page HTML.

Vous pouvez choisir d'effectuer le rendu complet du modèle en une seule fois ou de sélectionner des API individuelles pour le rendu.

Pour effectuer le rendu d'un modèle:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Contenu > <br class="ph-1-administration-1">
  3. Pour le modèle que vous souhaitez afficher, sélectionnez Révisions d'API sous "Opérations".
  4. Sélectionnez la révision que vous souhaitez afficher. Vous ne pouvez afficher les nœuds qu'à partir d'une seule révision du modèle.
  5. Sélectionnez les méthodes à afficher.
  6. Sélectionnez Render Nodes (Nœuds de rendu) dans le menu déroulant Update options (Mettre à jour les options).
  7. Cliquez sur Update (Mettre à jour).
  8. Un écran de chargement s'affiche pour indiquer la progression du rendu de vos nœuds.
    Une fois les nœuds affichés, l'ID du nœud Drupal pour chaque API s'affiche dans la colonne Node Association (Association de nœuds) du modèle. Cliquez sur le lien dans la colonne Association de nœuds pour afficher le nœud affiché.

Au lieu de sélectionner Render Nodes,vous pouvez sélectionner Render and publish nodes (Rendu et publier des nœuds) pour effectuer le rendu et publier immédiatement les API en tant que nœud Drupal.

Publier des nœuds

Un nœud n'est pas visible par les utilisateurs du portail tant qu'il n'a pas été publié. Vous pouvez éventuellement choisir de publier des nœuds pendant le processus de rendu. Si vous choisissez de ne pas publier les nœuds, vous devez les publier manuellement une fois le rendu terminé.

Pour publier un nœud:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Contenu > SmartDocs dans le menu d'administration de Drupal.
  3. Pour le modèle que vous souhaitez publier, sélectionnez Révisions de l'API sous "Opérations".
  4. Sélectionnez la révision que vous souhaitez publier. Vous ne pouvez publier des nœuds qu'à partir d'une seule révision du modèle.
  5. Sélectionnez les méthodes de publication.
  6. Sélectionnez les nœuds de la révision à publier.
  7. Sélectionnez Publish Nodes (Publier des nœuds) dans le menu déroulant Update options (Mettre à jour les options).
  8. Cliquez sur Update (Mettre à jour).
  9. Accédez au nœud en sélectionnant l'ID du nœud dans la colonne Association de nœuds.

Par défaut, l'URL Drupal qui pointe vers un nœud d'API publié se présente sous la forme suivante: http://<drupalBasePath>/<internalName>/apis/<httpMethod>/<resourcePath>. Pour contrôler le format de l'URL, procédez comme suit:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Configuration > Recherche et métadonnées > Alias d'URL > Formats dans le menu d'administration de Drupal.
  3. Sous Modèle pour tous les chemins d'accès des méthodes SmartDocs, spécifiez la manière dont vous souhaitez générer le chemin.
  4. Sélectionnez Enregistrer la configuration.

En raison de la mise en cache sur le portail, il est possible que les pages de vos modèles ne s'affichent pas immédiatement après leur publication. Si nécessaire, vous pouvez vider manuellement le cache HTML SmartDocs en procédant comme suit:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Configuration > SmartDocs dans le menu d'administration de Drupal.
  3. Cliquez sur Recompiler les caches de modèles SmartDocs.

Annuler la publication d'un nœud

Vous pouvez annuler la publication d'un nœud publié à tout moment. L'annulation de la publication d'un nœud le rend invisible pour les utilisateurs du portail.

Pour annuler la publication d'un nœud:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Contenu > SmartDocs.) dans le menu d'administration Drupal.
  3. Pour le modèle dont vous souhaitez annuler la publication, sélectionnez Révisions de l'API sous "Opérations".
  4. Sélectionnez la révision de modèle du nœud dont vous souhaitez annuler la publication.
  5. Sélectionnez les nœuds de la révision dont vous souhaitez annuler la publication.
  6. Sélectionnez Annuler la publication des nœuds dans le menu déroulant Options de mise à jour.
  7. Cliquez sur Update (Mettre à jour).

Afficher la révision d'un modèle

Pour créer une révision d'un modèle, vous pouvez importer un nouveau fichier WADL ou une spécification OpenAPI dans un modèle existant, ou créer manuellement une révision. Après avoir créé la nouvelle révision, vous pouvez effectuer son rendu et publier la révision, qui remplace les nœuds Drupal actuellement publiés.

Vous pouvez afficher et publier des nœuds à partir de plusieurs révisions à la fois. Ainsi, si vous disposez de cinq révisions d'un modèle, vous pouvez publier des nœuds à partir de n'importe quelle révision ou de toutes. Toutefois, la publication d'une API dans un modèle identique à celle d'un nœud publié d'un autre modèle annule la publication de l'ancienne version de l'API et la remplace par celle de la dernière API publiée.

Pour afficher la révision d'un modèle:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Contenu > SmartDocs dans le menu d'administration de Drupal.
  3. Pour le modèle que vous souhaitez mettre à jour, sélectionnez Révisions de l'API sous "Opérations".
  4. Sélectionnez la révision du modèle que vous souhaitez afficher.
  5. Affichez et publiez les nœuds comme décrit ci-dessus.

Modifier un nœud

Après avoir rendu un nœud, vous pouvez le modifier à l'aide de l'éditeur Drupal. Par exemple, vous pouvez modifier le verbe HTTP et la description d'une API, ou ajouter un nouveau paramètre de requête ou d'en-tête à l'API. Vous pouvez modifier les nœuds créés à partir d'un fichier WADL ou d'une spécification OpenAPI, ou des nœuds créés manuellement.

Vous pouvez également modifier le fichier WADL d'origine ou la spécification OpenAPI. Une fois les modifications terminées, réimportez le fichier WADL ou la spécification OpenAPI dans le modèle en tant que nouvelle révision, puis affichez et publiez vos modifications comme décrit ci-dessus.

Pour modifier un nœud à l'aide de l'éditeur Drupal:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Accédez au nœud Drupal correspondant à la documentation de l'API que vous souhaitez modifier.
  3. Sélectionnez Modifier pour utiliser l'éditeur Drupal.
  4. Une fois les modifications effectuées, sélectionnez Mettre à jour le mode.

Vous pouvez également modifier le nœud à partir du modèle SmartDocs:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Contenu > SmartDocs dans le menu d'administration de Drupal.
  3. Pour le modèle que vous souhaitez mettre à jour, sélectionnez Révisions de l'API sous "Opérations".
  4. Sélectionnez la révision du modèle que vous souhaitez publier.
  5. Sélectionnez Edit method (Modifier la méthode) dans le menu déroulant Operations (Opérations) pour la méthode à modifier.

Pour supprimer un nœud:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Contenu > SmartDocs dans le menu d'administration de Drupal.
  3. Pour le modèle que vous souhaitez mettre à jour, sélectionnez Révisions de l'API sous "Opérations".
  4. Sélectionnez la révision du modèle que vous souhaitez publier.
  5. Sélectionnez Supprimer la méthode dans le menu déroulant Opérations.
    Attention:La suppression du nœud supprime également l'API du modèle. Si vous souhaitez uniquement annuler la publication de l'API afin qu'elle soit masquée pour les utilisateurs du portail, sans la supprimer du modèle, vous devez annuler la publication du nœud comme décrit ci-dessus.

Le portail comporte un rapport intégré qui affiche des informations sur tout nœud rendu par un modèle SmartDocs qui ne fait plus référence à une méthode valide du modèle. Accédez au rapport en sélectionnant Rapports dans le menu Drupal, puis en sélectionnant le rapport nommé État du nœud SmartDocs.

Exporter et importer un modèle

SmartDocs vous permet d'exporter un modèle existant vers un fichier. Par exemple, vous pouvez définir un environnement de production et un environnement de préproduction. Vous effectuez ensuite toutes vos modifications SmartDocs dans l'environnement de préproduction. Lorsque vous êtes prêt à publier vos API, vous exportez le modèle de préproduction et l'importez dans le modèle de production.

L'importation d'un modèle crée une révision du modèle. SmartDocs tente de faire correspondre les API existantes du modèle avec les API importées. Si SmartDocs détecte une correspondance, l'importation met à jour le nœud Drupal correspondant à l'API existante. Si SmartDocs ne détecte pas de correspondance, l'importation crée un nœud Drupal pour l'API.

Par exemple, vous avez une API POST qui correspond à un nœud Drupal avec un ID de 91. Vous importez ensuite un modèle, et SmartDocs détecte une correspondance entre une API POST du modèle importé et l'API POST existante. Toute mise à jour de l'API POST met ensuite à jour le nœud Drupal 91. Si SmartDocs ne détecte pas de correspondance, il crée un nœud Drupal avec un nouvel ID.

Drupal effectue la mise en correspondance en utilisant les caractéristiques suivantes de l'API:

  • internalName: nom du modèle interne.
  • httpMethod : méthode HTTP de l'API, telle que GET, PUT, POST ou DELETE.
  • resourcePath: chemin d'accès à la ressource.
  • query params (paramètres de requête) : tous les paramètres de requête utilisés par l'API.

Si les quatre caractéristiques d'une API importée correspondent à une API existante du modèle, SmartDocs met à jour le nœud Drupal existant.

Le modèle exporté est représenté par un seul objet JSON avec des entrées pour les ressources et les méthodes. Cela signifie que vous pouvez modifier le modèle exporté pour changer une ressource ou une méthode, puis réimporter le modèle. Si vous modifiez l'objet JSON, ne modifiez pas les champs suivants:

  • revisionNumber
  • createdTime
  • modifiedTime
  • apiRevisionId
  • resourceId

Pour exporter un modèle:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Contenu > SmartDocs dans le menu d'administration de Drupal.
  3. Pour le modèle que vous souhaitez exporter, sélectionnez Exporter sous Opérations.
  4. Sélectionnez le type de fichier d'exportation SmartDocs JSON.
  5. Cliquez sur Exporter.
  6. Vous êtes invité à enregistrer le fichier sur le disque ou à l'ouvrir dans un éditeur.

Pour importer un modèle:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Contenu > SmartDocs dans le menu d'administration de Drupal.
  3. Pour le modèle que vous souhaitez importer, sélectionnez Importer sous Opérations.
  4. Sélectionnez SmartDocs JSON dans le menu déroulant Choose Format (Sélectionner un format).
  5. Sélectionnez Fichier ou URL dans Type d'importation :
    1. Si vous sélectionnez File (Fichier), accédez au fichier JSON.
    2. Si vous sélectionnez URL, spécifiez l'URL du fichier JSON SmartDocs.
  6. Cliquez sur Import (Importer) pour l'importer dans le modèle.
  7. Vous êtes redirigé vers la page d'informations du modèle où vous pouvez maintenant afficher le modèle. Notez que l'importation crée une révision du modèle.
  8. Affichez et publiez les nœuds.

Modifier le modèle SmartDocs

Le modèle SmartDocs définit la façon dont vos nœuds Drupal apparaissent à l'écran. Chaque modèle SmartDocs peut utiliser le même modèle par défaut, ou vous pouvez personnaliser manuellement le modèle utilisé pour un modèle individuel.

Le modèle SmartDocs comprend un fichier de modèle codé sous la forme d'un fichier .hbr Handlebars, de fichiers CSS et de fichiers JavaScript. Avec les poignées, une grande partie du contenu est déterminée par des variables à l'aide d'expressions de poignées intégrées, telles que &123;&123;body}}. Une liste des expressions de poignée existantes est fournie dans un commentaire en haut du fichier. Pour savoir comment utiliser des poignées pour personnaliser vos modèles, consultez le site http://handlebarsjs.com.

Les sections suivantes décrivent comment importer un fichier de modèle SmartDocs personnalisé pour tous les nouveaux modèles ou lorsque vous importez de nouvelles API dans un modèle existant, comment restaurer le fichier de modèle SmartDocs par défaut d'origine et comment modifier le modèle SmartDocs pour un modèle individuel.

Importation d'un fichier de modèle SmartDocs personnalisé

Vous pouvez importer un fichier de modèle SmartDocs personnalisé, sous la forme d'un fichier Handlebars, à utiliser comme modèle par défaut lorsque vous créez des modèles ou importez de nouvelles API dans un modèle existant.

Si vous souhaitez utiliser le fichier de modèle SmartDocs par défaut comme point de départ pour créer votre fichier de modèle SmartDocs personnalisé, vous pouvez en télécharger une copie depuis : profiles/apigee/modules/custom/devconnect/smartdocs/templates/smartdocs.hbr

Pour importer un fichier de modèle SmartDocs personnalisé:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Configuration > SmartDocs dans le menu d'administration de Drupal.
  3. Développez la zone Paramètres avancés de la page.
  4. Sous "Importer un modèle de méthode personnalisé", cliquez sur Sélectionner un fichier, puis accédez au fichier .hbr de Handlebars.
  5. Cliquez sur Importer.
  6. Cliquez sur Enregistrer la configuration.

Restauration du fichier de modèle SmartDocs par défaut

Vous pouvez restaurer le fichier de modèle SmartDocs par défaut. Une fois restauré, le fichier de modèle SmartDocs par défaut sera utilisé lors de la création de modèles ou de l'importation de nouvelles API dans un modèle existant.

Pour restaurer le fichier de modèle SmartDocs par défaut:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Configuration > SmartDocs dans le menu d'administration de Drupal.
  3. Développez la zone Paramètres avancés de la page.
  4. Sous "Importer un modèle de méthode personnalisée", cliquez sur Supprimer à côté du fichier de modèle SmartDocs personnalisé.
  5. Cliquez sur Enregistrer la configuration.

Modifier le modèle SmartDocs pour un modèle individuel

Vous pouvez modifier le modèle utilisé pour un modèle individuel.

Pour modifier le modèle d'un modèle individuel:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Contenu > SmartDocs dans le menu d'administration de Drupal.
  3. Pour le modèle que vous souhaitez modifier, sélectionnez Paramètres sous Opérations.
  4. Dans la zone Modèle de méthode, modifiez le modèle selon vos besoins.
  5. Cliquez sur Enregistrer le modèle.
  6. Accédez à un nœud Drupal. Les modifications apportées à votre modèle doivent s'afficher sur la page.

Configurer le type d'authentification SmartDocs

Les API définies dans SmartDocs peuvent être ouvertes, ce qui signifie qu'aucun identifiant d'authentification n'est requis pour y accéder, ou sécurisées. Une API sécurisée nécessite la transmission d'identifiants lorsque vous appelez l'API.

Pour une API sécurisée, SmartDocs prend en charge les types d'authentification suivants:

  • Authentification de base : transmettez des identifiants d'authentification de base sous la forme d'une paire nom d'utilisateur/mot de passe. Si vous ne spécifiez pas le type d'identifiant OAuth, l'API utilise par défaut l'authentification de base.
  • OAuth 2.0 : un fournisseur de services tiers authentifie les identifiants de l'utilisateur, s'assure que celui-ci est autorisé à accéder à l'API, puis émet un jeton d'accès. Lorsque vous envoyez une requête SmartDocs à une API protégée, SmartDocs crée la requête et l'envoie au fournisseur de services. Le fournisseur de services valide ensuite le jeton et s'assure qu'il n'a pas expiré.
  • Jeton personnalisé : transmettez une valeur de jeton sous forme d'en-tête ou de paramètre à chaque requête.

Pour chaque type d'authentification, vous créez un schéma de sécurité qui définit les caractéristiques de l'authentification. Par exemple, pour l'authentification par jeton personnalisé, le schéma de sécurité définit la manière dont le jeton est transmis (en-tête, paramètre de requête, paramètre de corps) et son nom.

Un schéma de sécurité est associé à une révision spécifique d'un modèle. Par conséquent, si vous créez une révision d'un modèle, vous devez redéfinir les schémas de sécurité de cette révision.

Dans un fichier WADL, vous spécifiez si une API nécessite une authentification à l'aide du tag Apigee <apigee:authentication>, comme indiqué ci-dessous:

<method id="statusespublic_timeline" name="GET" apigee:displayName="PublicTimeline">
    ...
    <apigee:authentication required="true"/>
</method> 

Si l'API est ouverte, définissez l'attribut required sur false.

Notez que vous ne pouvez pas spécifier le type d'authentification dans le fichier WADL. Pour ce faire, modifiez le nœud dans Drupal. Pour en savoir plus sur les fichiers WADL, consultez la documentation de référence WADL.

Sur la page de l'API dans Drupal, SmartDocs ajoute le bouton suivant pour permettre aux utilisateurs de spécifier leurs identifiants d'authentification de base:

Si vous modifiez le nœud pour définir le type d'authentification sur OAuth, SmartDocs ajoute le bouton suivant à la page:

Pour un jeton personnalisé, SmartDocs ajoute:

Configurer l'authentification de base

Si vous utilisez l'authentification de base avec votre API, il vous suffit de spécifier la balise <apigee:authentication> dans le fichier WADL que vous utilisez pour créer le modèle.

Pour appliquer une authentification de base à des méthodes créées à partir d'une source autre qu'un fichier WADL:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Contenu > SmartDocs dans le menu d'administration de Drupal.
  3. Pour le modèle souhaité, sélectionnez Révisions d'API sous "Opérations".
  4. Pour la révision de modèle que vous souhaitez modifier, sélectionnez Security Settings (Paramètres de sécurité) sous Operations (Opérations).
  5. Sélectionnez Ajouter un schéma de sécurité.
  6. Indiquez le name du schéma de sécurité.
  7. Sélectionnez le type Basic.
  8. Sélectionnez Envoyer.
  9. Pour chaque méthode du modèle, modifiez-la pour définir son schéma de sécurité sur votre schéma de base.
    1. Sélectionnez Contenu > SmartDocs dans le menu d'administration de Drupal.
    2. Pour le modèle souhaité, sélectionnez Révisions d'API sous "Opérations".
    3. Pour la révision du modèle que vous souhaitez modifier, sélectionnez Détails de la révision sous Opérations.
    4. Sélectionnez Edit Method (Modifier la méthode) pour l'API que vous souhaitez modifier.
    5. Sélectionnez le schéma de sécurité de l'API.
    6. Enregistrez l'API.

Configurer l'authentification OAuth 2.0

Vous pouvez configurer un modèle de sorte qu'il utilise OAuth 2.0 dans SmartDocs au lieu de l'authentification de base par défaut. Vous configurez OAuth à deux emplacements:

  1. Créez un schéma de sécurité pour chaque révision d'un modèle sous Paramètres de sécurité pour la révision.
  2. Spécifiez l'ID et le code secret du client pour toutes les révisions du modèle dans la section Paramètres du modèle.

Pour activer OAuth:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Contenu > SmartDocs dans le menu d'administration de Drupal.
  3. Pour le modèle souhaité, sélectionnez Révisions d'API sous "Opérations".
  4. Pour la révision de modèle que vous souhaitez modifier, sélectionnez Paramètres de sécurité sous Opérations.
  5. Sélectionnez Ajouter un schéma de sécurité.
  6. Indiquez le name du schéma de sécurité.
  7. Dans le champ Type, sélectionnez OAuth 2.0.
  8. Définissez le type d'attribution.
  9. Saisissez les valeurs dans les champs URL d'autorisation. L'URL d'autorisation permet d'obtenir le jeton d'accès.
  10. Définissez le verbe d'autorisation sur GET ou POST.
  11. Saisissez l'URL du jeton d'accès. L'URL du jeton d'accès est l'URL utilisée pour échanger le jeton de requête contre un jeton d'accès.
  12. Saisissez le nom du paramètre de jeton d'accès.
  13. Utilisez In pour spécifier comment transmettre le jeton: Header (En-tête), Query (Requête) ou Body (Corps).
  14. Définissez les champs d'application OAuth.
  15. Sélectionnez Envoyer.
  16. Sélectionnez Contenu > SmartDocs dans le menu d'administration de Drupal.
  17. Sélectionnez Paramètres dans le menu déroulant Opérations correspondant au modèle.
  18. Saisissez les valeurs dans les champs ID client et Code secret du client.
  19. Sélectionnez Enregistrer les paramètres d'authentification des modèles.
  20. Pour chaque méthode du modèle, modifiez-la pour définir son schéma de sécurité sur votre schéma de sécurité OAuth.
    1. Sélectionnez Contenu > SmartDocs dans le menu d'administration de Drupal.
    2. Pour le modèle souhaité, sélectionnez Révisions d'API sous "Opérations".
    3. Pour la révision du modèle que vous souhaitez modifier, sélectionnez Détails de la révision sous Opérations.
    4. Sélectionnez Edit Method (Modifier la méthode) pour l'API que vous souhaitez modifier.
    5. Sélectionnez le schéma de sécurité de l'API.
    6. Enregistrez l'API.

Configurer l'authentification par jeton personnalisé

Vous pouvez configurer un modèle pour utiliser l'authentification par jeton personnalisé.

Pour activer les jetons personnalisés:

  1. Connectez-vous à votre portail en tant qu'utilisateur disposant des droits d'administrateur ou de création de contenu.
  2. Sélectionnez Contenu > SmartDocs dans le menu d'administration de Drupal.
  3. Pour le modèle souhaité, sélectionnez Révisions d'API sous "Opérations".
  4. Pour la révision de modèle que vous souhaitez modifier, sélectionnez Security Settings (Paramètres de sécurité) sous Operations (Opérations).
  5. Sélectionnez Ajouter un schéma de sécurité.
  6. Indiquez le name du schéma de sécurité.
  7. Sélectionnez Clé API dans le champ Type.
  8. Définissez le nom du paramètre contenant le jeton.
  9. Utilisez In pour spécifier comment transmettre le jeton: Header, Query ou Body.
  10. Sélectionnez Envoyer.
  11. Pour chaque méthode du modèle, modifiez-la pour définir son schéma de sécurité sur votre schéma de jeton.
    1. Sélectionnez Contenu > SmartDocs dans le menu d'administration de Drupal.
    2. Pour le modèle souhaité, sélectionnez Révisions d'API sous "Opérations".
    3. Pour la révision du modèle que vous souhaitez modifier, sélectionnez Détails de la révision sous Opérations.
    4. Sélectionnez Edit Method (Modifier la méthode) pour l'API que vous souhaitez modifier.
    5. Sélectionnez le schéma de sécurité de l'API.
    6. Enregistrez l'API.

Supprimer un modèle

Lorsque vous supprimez un modèle (Contenu > SmartDocs, Supprimer dans le champ Opérations de Drupal), le modèle est supprimé de votre organisation Edge. Cela signifie que si d'autres portails font référence au modèle, celui-ci n'est plus disponible. Pour en savoir plus, consultez la section À propos des modèles et des modèles SmartDoc.