Documenter les API avec SmartDocs

<ph type="x-smartling-placeholder"></ph> Vous consultez la documentation Apigee Edge.
Accédez à la page Documentation sur Apigee X. En savoir plus

SmartDocs vous permet de documenter vos API sur le portail des développeurs Drupal 7 de manière à rendre documentation de l'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 permettez à l'utilisateur du portail pour apprendre, tester et évaluer 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 quelle client HTTP. Apigee utilise SmartDocs pour créer une documentation interactive pour la gestion Edge API. Pour consulter la documentation de cette API, cliquez ici.

Exemple de portail SmartDocs

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

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

Deux API sont décrites sur le portail: Hello World et Pet Store Example.

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

L'API d'exemple pour l'animalerie a été créée à partir de la démonstration classique de l'animalerie.

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 de l'API. Les SmartDocs de cette ressource sont affiché:
  3. Cliquez sur Send this request (Envoyer cette demande).
  4. Affichez 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 (Demande) pour afficher la requête ou sur la touche cURL. pour afficher l'appel cURL correspondant.

Comment documenter vos API à l'aide de SmartDocs

SmartDocs représente vos API par le biais d'un modèle, qui contient tous les des informations sur vos API. Le portail extrait des informations sur vos API du modèle pour afficher les pages de documentation sur le portail sous forme de nœuds Drupal, où chaque nœud Drupal correspond vers une page de documentation sur le portail.

Pour utiliser les SmartDocs, procédez comme suit:

  1. Configurez le module SmartDocs de Drupal sur le portail.
  2. Créez un modèle SmartDocs.
  3. Ajouter des API au modèle à partir d'un fichier WADL, OpenAPI (anciennement Swagger) la spécification, ou manuellement.
  4. Effectuer le rendu du modèle sous forme de collection de nœuds Drupal Chaque nœud Drupal contient des informations sur une seule API. Par exemple, si une ressource de votre API prend en charge à la fois POST et une requête PUT, SmartDocs crée un nœud Drupal distinct pour les requêtes POST et PUT.
  5. Publiez les nœuds Drupal. Une fois publiés, les utilisateurs de votre portail peuvent consulter interagissent avec votre API.
  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 et la spécification OpenAPI. Lorsque vous avez terminé de modifier le fichier WADL ou la spécification OpenAPI, importez dans le modèle en tant que nouvelle révision, puis afficher et publier vos modifications.
  7. Activez le protocole TLS. Comme SmartDocs peut envoyer des identifiants d'authentification dans le cadre d'une requête adressée à vos API, vous devez activer 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 quitter disponible sur votre portail, vous devez obtenir votre propre certificat TLS et l'activer. Pour en savoir plus, consultez L'utilisation du protocole TLS portail.

À propos des modèles et des modèles SmartDoc

Lorsque vous créez un modèle dans votre portail, il est en fait stocké dans votre Edge et non dans Drupal. Un modèle est un grand bloc de code JSON ayant un nom interne (comme "my-smartdocs-api"), et il définit la structure d'une API. Votre portail, en revanche, affiche le modèle en HTML et fournit une interface d'édition pour le modèle. Toute mise à jour de l'API du portail sont automatiquement réintégrés dans le modèle source.

Stocké dans l'organisation

Stocké dans Drupal

modèles

templates

Nœuds Drupal avec fonctionnalité de modification

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

Les modèles contrôlent l'apparence de vos SmartDocs, et ces modèles (gérés par Handlebars et fichiers CSS) sont stockés avec chaque instance du 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 un modèle que vous fournissez) est automatiquement appliquée à chaque modèle.

Le schéma suivant illustre la relation entre les modèles et les portails. Les flèches vertes indiquent et 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

Configuration du module SmartDocs

Apigee a implémenté SmartDocs en tant que module Drupal personnalisé. Procédez comme suit pour configurer le module SmartDocs.

<ph type="x-smartling-placeholder">

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 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 de Drupal.
  6. Sélectionnez SmartDocs -> Autorisations et assurez-vous que l'option pour le module SmartDocs." pour "Administrateur" est activé.
  7. Sélectionnez Configuration > Portail des développeurs dans l'administration Drupal .
  8. Définissez les paramètres Connection Timeout et Request Timeout (Délai avant expiration de la connexion) sur 16. secondes.
  9. Enregistrez la configuration.
  10. Configurez les paramètres d'URL: <ph type="x-smartling-placeholder">
      </ph>
    1. Sélectionnez Configuration > Recherche et métadonnées > Alias d'URL > Settings (Paramètres) dans le menu Drupal.
    2. Définissez les champs Longueur maximale d'alias et Nombre maximal de composants. length sur 255.
    3. Développez Ponctuation.
    4. Pour les accolades ouvrantes ({) et accolade fermante (}), 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 qui n'ont pas accès à ou si un sous-ensemble de vos API se trouve sur un réseau privé, configurez l'API SmartDocs URL de proxy, comme suit: <ph type="x-smartling-placeholder">
      </ph>
    1. Sélectionnez Configuration > SmartDocs dans la documentation Administration de Drupal .
    2. Développez la section Paramètres avancés.
    3. Modifiez 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. Exemple:
      https://api-us-east-1-enterprise.apigee.com/smartdocs/v1/sendrequest

      La valeur par défaut de ce champ est la suivante : 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 en un seul dans un modèle de ML.

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

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 supprimer.
  • resourcePath: chemin d'accès à la ressource.

Par exemple, si vous spécifiez "monmodèle" comme nom interne, l'URL du modèle Nœud Drupal pour une requête GET envoyée à une ressource nommée '/books' est:

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 l'API structure. Pour en savoir plus, consultez À propos des modèles SmartDoc et modèles de ML.

  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 l'administration Drupal .
  3. Sélectionnez Nouveau modèle en haut de la page.
  4. Renseignez les champs suivants: <ph type="x-smartling-placeholder">
      </ph>
    • Nom: nom du modèle qui sera affiché sur le site.
    • Nom interne: lorsque vous saisissez le nom, le nom 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.

Après avoir créé le modèle, vous êtes redirigé vers la page du modèle. À 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 API OpenAPI Spécification décrivant votre API.
  • Ajouter une révision au modèle
  • Modifiez les paramètres du modèle, y compris les feuilles de style utilisées par la dans un modèle de ML.
  • Exportez le modèle dans un fichier.
  • Supprimez le modèle.

Ajouter des API à un modèle

Vous pouvez ajouter des API à un modèle de plusieurs façons:

  • 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éé par exporter un modèle existant, modifier le fichier, puis importer les mises à jour. Pour en savoir plus, Consultez la page Exporter et importer un modèle. ci-dessous.

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

Importer un WADL

Une fois votre modèle créé, importez un fichier WADL décrivant votre API. Toutes les lorsque vous importez un fichier WADL, vous créez automatiquement une nouvelle 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 Contenu > les SmartDocs dans Drupal ; d'administration.
  3. Sélectionnez le modèle que vous souhaitez mettre à jour.
  4. Sous Opérations, sélectionnez Importer.
  5. Sélectionnez WADL dans le menu déroulant Choose Format (Choisir un format) de la page d'importation SmartDocs.
  6. Sélectionnez Fichier ou URL dans Importer Type.
    1. Si vous sélectionnez Fichier, recherchez le fichier WADL.
    2. Si vous sélectionnez URL, spécifiez l'URL du fichier WADL.
  7. Cliquez sur Importer pour l'importer dans le modèle. Vous pouvez maintenant le rendu du modèle.
  8. Vous êtes redirigé vers la page d'informations du modèle, où vous pouvez afficher dans un modèle de ML.

Importer une bibliothèque OpenAPI Spécifications

Après avoir créé un modèle, vous pouvez importer une bibliothèque OpenAPI (anciennement Swagger) Spécification. Edge est compatible avec les versions 1.2 et 2.0 d'OpenAPI.

OpenAPI décrit une API à l'aide de fichiers contenant des objets JSON. Chaque fois que vous importez une spécification OpenAPI, vous créez automatiquement une nouvelle révision du modèle.

<ph type="x-smartling-placeholder">

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électionner Contenu > SmartDocs 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 ou Swagger YAML dans le fichier Menu déroulant Sélectionner un format sur la page d'importation SmartDocs.
  6. Sélectionnez Fichier ou URL dans Menu déroulant Upload Type (Type d'importation) (vous devez sélectionner URL pour OpenAPI 1.2).
    1. Si vous sélectionnez File (Fichier), accédez à la bibliothèque OpenAPI Spécification.
    2. Si vous sélectionnez URL, spécifiez l'URL de l'OpenAPI Spécification.
  7. Cliquez sur Importer pour l'importer dans le modèle.
  8. Vous êtes redirigé vers la page d'informations du modèle, où vous pouvez afficher dans un modèle de ML.

Créer des ressources manuellement et méthodes

Si vous ne disposez pas d'un fichier WADL ou d'une spécification OpenAPI représentant votre API, vous pouvez manuellement des API à votre modèle. De plus, si vous utilisez un fichier WADL ou une spécification OpenAPI pour créer modèle, vous pouvez suivre cette procédure pour modifier vos API, y compris pour ajouter de nouvelles API, 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 d'accès de base en tant que:

    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 combiné au chemin de base de la révision du modèle pour 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 "/login" ressource, vous prenez en charge 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, l'une pour la méthode POST et l'autre pour la méthode DELETE.

    La méthode utilise l'URL de la ressource parente. Par conséquent, toutes les méthodes ayant les URL sont définies pour une ressource unique 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 dans 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à d'une révision, vous pouvez ajouter votre ressource. Si le modèle est nouveau et ne comporte aucune révision, la 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électionner Contenu > SmartDocs dans le menu d'administration Drupal.
  3. Pour le modèle que vous souhaitez mettre à jour, sélectionnez Ajouter une révision. sous Opérations.
  4. Sur la page Add API Revision (Ajouter une révision de l'API), saisissez les informations suivantes: <ph type="x-smartling-placeholder">
      </ph>
    • Nom à afficher: nom de la révision tel qu'il apparaît dans 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. A peut utiliser différentes URL de base pour chaque révision. Par exemple, vous incluez une 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 chemin d'accès à la ressource, 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électionner Contenu > SmartDocs dans le menu d'administration Drupal.
  3. Pour le modèle que vous souhaitez mettre à jour, sous Opérations, sélectionnez API Révisions 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: <ph type="x-smartling-placeholder">
      </ph>
    • Nom à afficher: nom de la ressource.
    • Chemin d'accès: le chemin d'accès à la ressource, commençant par "/". La valeur Le chemin d'accès est combiné à 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. sur 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 pour définir des méthodes sur la ressource.

Vous pouvez éventuellement ajouter des paramètres à la ressource, tels qu'un modèle, une requête et un en-tête paramètres. Tous les paramètres d'une 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 doit être compatible avec ce paramètre de requête.

Vous pouvez également définir des paramètres sur une méthode. Par exemple, une méthode POST peut prendre en charge paramètres de requête qui ne sont pas pris en charge par une méthode DELETE. Par conséquent, ajoutez des paramètres spécifiques à une méthode lorsque vous la définissez, comme décrit ci-dessous.

L'image suivante montre une page SmartDocs existante pour la classe L'API Apigee Validate ou Revoke Developer App affiche chaque type de paramètre en surbrillance:

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

Type

Objet JSON

Remarques

Modèle

{
"dataType": "chaîne",
"defaultValue": "",
"description": "Nom de l'organisation.",
"name": "nom_organisation",
"required": true,
"type": "MODÈLE"
}

Les paramètres de modèle sont toujours obligatoires. Définissez donc required sur true et omettez la valeur sur defaultValue.

La valeur description s'affiche dans une fenêtre pop-up lorsque l'utilisateur pointe sur l'URL d'une page SmartDocs.

Requête

{
"dataType": "chaîne",
"defaultValue": "",
"description": "Le lieu.",
"name": "w",
"required": true,
"type": "QUERY"
}

Les paramètres de requête requis peuvent toujours spécifier une valeur defaultValue, mais ce n'est généralement pas le cas.

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

En-tête

{
"dataType": "chaîne",
"defaultValue": "application/json",
"description": "Spécifiez <code>application/json</code>.",
"name": "Content-Type",
"required": true,
"type": "HEADER"
}

Notez comment 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 la façon dont chaque définition de paramètre dans le tableau de paramètres sont séparés 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 de la ressource, délimitée par "{}". Par exemple, définissez le chemin d'accès comme suit:

/login/{org_name}/{developer_email}

Sur la page de l'API SmartDocs, l'utilisateur doit modifier l'URL pour spécifier les parties org_name et developer_email de l'URL avant il peut 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és sur la ressource. Une seule méthode peut être définie sur une ressource. plusieurs méthodes.

Lors de la définition de la méthode, spécifiez tous ses paramètres, y compris les paramètres de requête et paramètres d'en-tête. Consultez la description ci-dessus pour en savoir plus sur l'ajout de paramètres. à une méthode.

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

L'image suivante montre la même page, mais avec l'option "Description of the Request Body" (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électionner Contenu > SmartDocs dans le menu d'administration Drupal.
  3. Pour le modèle que vous souhaitez mettre à jour, sous Opérations, sélectionnez API Révisions 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 méthode dans le menu déroulant de l'une des méthodes les ressources.
  6. Sur la page Modifier la méthode, saisissez les informations suivantes: <ph type="x-smartling-placeholder">
      </ph>
    • Nom à afficher: nom de l'API, qui devient également le titre de la Page Drupal pour l'API.
    • Description: décrivez l'API.
    • Méthode Verb: type de verbe HTTP.
    • Schémas de sécurité: spécifiez le mode d'authentification, le cas échéant, pour les . Pour en savoir plus, consultez la section Configuration de l'authentification SmartDocs d'entrée.
    • Type de contenu: type de contenu de la requête et de la réponse. Consultez le ci-dessous sur la configuration des différentes méthodes d'authentification.
    • Parameters (Paramètres) : (facultatif) 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.
    • Request Body Documentation (Documentation du corps de la requête) : (facultatif) décrivez le corps de la requête. PUBLIER et PUT acceptent un corps de requête. Vous pouvez utiliser cette zone pour la décrire. Si vous omettez cette , le lien Description sous Request Body (Corps de la requête) est omis. sur la page SmartDocs générée.
    • Exemple de corps de requête: (facultatif) montrez un exemple de corps de requête. généralement sous forme d'objet JSON ou XML. Pour les verbes POST et PUT, le corps de la requête Example est transmis dans chaque requête. Les utilisateurs de la page SmartDocs modifient ce paramètre. avant d'envoyer une requête à l'API. Si vous omettez cette valeur, le Value (Valeur) sous Request Body (Corps de la requête) est omise dans le champ page SmartDocs générée.
    • Tags: tableau des tags associés à l'API. SmartDocs utilise des tags pour pour regrouper des API similaires. Par exemple, vous pouvez appliquer le tag "Statistiques" à toutes les API sur les statistiques. Vous pouvez regrouper les API de différentes ressources dans un seul tag. s'ils 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 pour afficher et publier votre méthode.

Afficher un modèle

Après avoir ajouté des API à un modèle, vous pouvez effectuer son rendu. L'affichage convertit les données de l'API dans les nœuds Drupal. Une fois le rendu terminé, pour chaque API, où chaque nœud Drupal correspond à une page HTML.

Vous pouvez choisir d'afficher l'intégralité du modèle en une seule fois ou sélectionner des API individuelles pour le rendu.

Pour effectuer le rendu d'un modèle, 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électionner Contenu > SmartDocs dans le menu d'administration Drupal.
  3. Pour le modèle que vous souhaitez afficher, sélectionnez Révisions de l'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 de le modèle.
  5. Sélectionnez les méthodes à afficher.
  6. Sélectionnez Render Nodes (Nœuds de rendu) dans Update (Mettre à jour). Options.
  7. Cliquez sur Mettre à jour.
  8. Un écran de chargement s'affiche pour suivre la progression du rendu de vos nœuds.
    Une fois les nœuds rendus, l'identifiant du nœud Drupal pour chaque API apparaît sous le Colonne Association de nœuds du modèle. Cliquez sur le lien dans le Node (Node). Association pour afficher le nœud rendu.

Au lieu de sélectionner Nœuds de rendu,vous pouvez sélectionner Rendu et publier des nœuds pour afficher 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'est pas publié. Vous pouvez aussi choisir publier des nœuds pendant le processus de rendu. Si vous choisissez de ne pas publier les nœuds, vous devrez 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électionner Contenu > SmartDocs dans le menu d'administration 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 à publier.
  6. Sélectionnez les nœuds de la révision à publier.
  7. Dans le champ Update (Mettre à jour), sélectionnez Publish Nodes (Publier les nœuds) Options.
  8. Cliquez sur Mettre à jour.
  9. Accédez au nœud en sélectionnant son ID dans le champ Association de nœuds. .

Par défaut, l'URL Drupal d'un nœud d'API publié se présente sous la forme: http://<drupalBasePath>/<internalName>/apis/<httpMethod>/<resourcePath>. Pour contrôler la forme 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 > Modèles dans le menu d'administration de Drupal.
  3. Sous Modèle pour tous les chemins d'accès de méthode SmartDocs, indiquez la manière dont vous souhaitez générer le chemin d'accès.
  4. Sélectionnez Enregistrer la configuration.

En raison de la mise en cache sur le portail, il est possible que les pages de votre modèle n'apparaissent pas immédiatement après leur publication. Si nécessaire, vous pouvez vider manuellement le cache HTML SmartDocs à l'aide de la la procédure suivante:

  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 l'administration Drupal .
  3. Cliquez sur Recréer les caches du modèle SmartDocs.

Annuler la publication d'un nœud

Vous pouvez annuler la publication d'un nœud à tout moment. L'annulation de la publication d'un nœud le rend invisible pour des 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électionner 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 du 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. Dans le champ Update (Mettre à jour), sélectionnez Unpublish Nodes (Annuler la publication) Options.
  7. Cliquez sur Mettre à jour.

Afficher la révision d'un modèle

Pour créer une révision d'un modèle, importez un nouveau fichier WADL ou une nouvelle spécification OpenAPI dans un modèle existant, ou en créant manuellement une nouvelle révision. Après avoir créé la révision, vous pouvez afficher 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 en même temps. Cela signifie que si vous avez cinq révisions d'un modèle, vous pouvez publier des nœuds à partir d'une ou de toutes les révisions. Toutefois, la publication une API dans un modèle identique à un nœud publié d'un autre modèle annule la publication de l'ancien de l'API et la remplace par celle de la dernière version publiée API.

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électionner Contenu > SmartDocs dans le menu d'administration 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. Toi peuvent modifier les nœuds créés à partir d'un fichier WADL ou d'une spécification OpenAPI, ou les nœuds qui ont été créés manuellement.

Vous pouvez également modifier le fichier WADL d'origine ou la spécification OpenAPI. Lorsque vous avez terminé modifier, importer 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 Edit (Modifier) pour utiliser l'éditeur Drupal.
  4. Une fois les modifications effectuées, sélectionnez Mettre à jour la méthode.

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 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 de modèle que vous souhaitez publier.
  5. Sélectionnez Modifier la méthode dans le menu déroulant Opérations de la que vous souhaitez 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 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 de modèle que vous souhaitez publier.
  5. Sélectionnez Supprimer la méthode dans le menu déroulant Opérations de la méthode.
    Attention:La suppression du nœud supprime également l'API du modèle. Si vous n'utilisez souhaiter annuler la publication de l'API pour qu'elle ne soit pas visible par les utilisateurs du portail, mais pas la supprimer. du modèle, vous devez annuler la publication du nœud comme décrit ci-dessus.

Le portail dispose d'un rapport intégré qui affiche des informations sur tout nœud rendu par modèle SmartDocs qui ne font plus référence à une méthode valide du modèle. Pour accéder au rapport, Sélectionner Reports dans le menu Drupal, puis sélectionner le rapport nommée État du nœud SmartDocs.

Exporter et importer un modèle

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

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

Par exemple, l'API POST correspond à un nœud Drupal dont l'ID est 91. Ensuite, importer un modèle, et SmartDocs détecte une correspondance entre une API POST dans le modèle importé et API POST. Les éventuelles mises à jour de l'API POST mettent à jour le nœud Drupal 91. Si SmartDocs ne détecte pas de un nœud Drupal avec un nouvel identifiant.

Drupal effectue la 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 SUPPRIMER.
  • 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 dans le modèle, alors 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 méthodes. Cela signifie que vous pouvez modifier le modèle exporté pour modifier 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électionner Contenu > SmartDocs dans le menu d'administration 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électionner Contenu > SmartDocs dans le menu d'administration 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 (Choisir un format).
  5. Sélectionnez Fichier ou URL dans Type d'importation : <ph type="x-smartling-placeholder">
      </ph>
    1. Si vous sélectionnez Fichier, recherchez le fichier JSON.
    2. Si vous sélectionnez URL, indiquez l'URL du fichier JSON SmartDocs.
  6. Cliquez sur Importer pour l'importer dans le modèle.
  7. Vous êtes redirigé vers la page d'informations du modèle, où vous pouvez afficher dans un modèle de ML. Notez que l'importation crée une nouvelle révision du modèle.
  8. Affichez et publiez les nœuds.

Modification du modèle SmartDocs

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

Le modèle SmartDocs comprend un fichier de modèle codé sous la forme d'un fichier .hbr Handlebars, des fichiers CSS, et JavaScript. Avec les guidons, une grande partie du contenu est régie par des variables grâce à des les expressions de guidon, telles que &123;&123;body}}. Une liste des Les expressions du guidon sont fournies dans un commentaire en haut du fichier. Pour en savoir plus sur Personnalisez vos modèles à l'aide de Handlebars. Pour en savoir plus, consultez http://handlebarsjs.com.

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

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

Vous pouvez importer un fichier de modèle SmartDocs personnalisé, sous la forme d'un fichier .hbr Handlebars, à utiliser comme fichier modèle par défaut lors de la création de modèles ou de l'importation 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 la console Drupal d'administration.
  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. accédez au fichier .hbr du Handlebars.
  5. Cliquez sur Importer.
  6. Cliquez sur Enregistrer la configuration.

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

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

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 la console Drupal d'administration.
  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é de l'option modèle SmartDocs personnalisé.
  5. Cliquez sur Enregistrer la configuration.

Modification... 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 pour 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électionner Contenu > SmartDocs dans le menu d'administration Drupal.
  3. Sélectionnez Paramètres sous le modèle à modifier. 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 au modèle doivent s'afficher sur la page.

Configurer le Type d'authentification SmartDocs

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

Pour garantir une API sécurisée, SmartDocs est compatible avec les types d'authentification suivants:

  • Authentification de base : transmettez les identifiants d'authentification de base nom d'utilisateur et mot de passe. Si vous n'indiquez pas d'utiliser OAuth comme type d'identifiants, l'API utilise par défaut l'authentification de base.
  • OAuth 2.0 : un fournisseur de services tiers authentifie les les identifiants, s'assure que l'utilisateur dispose de l'autorisation d'accéder à l'API, puis émet un accès à partir d'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 qu'il n'a pas expiré.
  • Jeton personnalisé : transmettez une valeur de jeton en tant que paramètre d'en-tête ou de requête à chaque requête.

Pour chaque type d'authentification, vous créez un schéma de sécurité qui définit 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 le nom du le jeton.

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

Dans un fichier WADL, vous spécifiez si une API nécessite une authentification en utilisant le tag Apigee &lt;apigee:authentication&gt;, comme 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, modifier le nœud dans Drupal. Pour plus d'informations sur les fichiers WADL, consultez la page WADL Documentation de référence.

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

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

Pour le jeton personnalisé, SmartDocs ajoute:

Configurer authentification de base

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

Pour appliquer l'authentification de base aux 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 Drupal.
  3. Sélectionnez le modèle souhaité, sous Révisions de l'API, Opérations.
  4. Pour la révision de modèle que vous souhaitez modifier, sélectionnez Sécurité Paramètres sous Opérations.
  5. Sélectionnez Add Security Scheme (Ajouter un schéma de sécurité).
  6. Spécifiez le nom du schéma de sécurité.
  7. Sélectionnez Basic dans le champ Type.
  8. Sélectionnez Envoyer.
  9. Pour chaque méthode du modèle, modifiez la méthode afin de définir son schéma de sécurité à votre schéma de base.
    1. Sélectionnez Contenu > SmartDocs dans le menu d'administration Drupal.
    2. Sélectionnez le modèle souhaité, sous Révisions de l'API, Opérations.
    3. Pour la révision du modèle que vous souhaitez modifier, sélectionnez Révision plus d'informations 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 Authentification OAuth 2.0

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

  1. Créez un schéma de sécurité pour chaque révision d'un modèle sous Sécurité Paramètres de la révision.
  2. Spécifiez l'ID et le code secret du client pour toutes les révisions du modèle sous 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 Drupal.
  3. Pour le modèle souhaité, sélectionnez Révisions de l'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 Add Security Scheme (Ajouter un schéma de sécurité).
  6. Spécifiez le nom du schéma de sécurité.
  7. Sélectionnez OAuth 2.0 comme Type.
  8. Définissez le type d'attribution.
  9. Saisissez les valeurs dans les champs URL d'autorisation. L'autorisation est utilisée pour 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 demande contre un jeton d'accès.
  12. Saisissez le nom du paramètre du jeton d'accès.
  13. Utilisez In pour spécifier le mode de transmission du jeton: Header, 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 Drupal.
  17. Pour le modèle, sélectionnez Paramètres sous Opérations. liste déroulante.
  18. Renseignez les champs ID client et Client Secret :
  19. Sélectionnez Enregistrer les paramètres d'authentification du modèle.
  20. Pour chaque méthode du modèle, modifiez la méthode afin de définir son schéma de sécurité à votre schéma de sécurité OAuth.
    1. Sélectionnez Contenu > SmartDocs dans le menu d'administration Drupal.
    2. Sélectionnez le modèle souhaité, sous Révisions de l'API, Opérations.
    3. Pour la révision du modèle que vous souhaitez modifier, sélectionnez Révision plus d'informations 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 Drupal.
  3. Sélectionnez le modèle souhaité, sous Révisions de l'API, Opérations.
  4. Pour la révision de modèle que vous souhaitez modifier, sélectionnez Sécurité Paramètres sous Opérations.
  5. Sélectionnez Add Security Scheme (Ajouter un schéma de sécurité).
  6. Spécifiez le nom du schéma de sécurité.
  7. Sélectionnez Apikey dans le champ Type.
  8. Définissez le paramètre Name contenant le jeton.
  9. In pour spécifier comment transmettre la jeton: En-tête, Requête ou Body.
  10. Sélectionnez Envoyer.
  11. Pour chaque méthode du modèle, modifiez la méthode afin de définir son schéma de sécurité à votre schéma de jetons.
    1. Sélectionnez Contenu > SmartDocs dans le menu d'administration Drupal.
    2. Sélectionnez le modèle souhaité, sous Révisions de l'API, Opérations.
    3. Pour la révision du modèle que vous souhaitez modifier, sélectionnez Révision plus d'informations 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, cliquez sur Supprimer dans champ Operations dans 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 plus d'informations, Consultez la page À propos des modèles et des modèles SmartDoc.