--- title: "Comment utiliser Swagger" slug: "how-to-use-swagger" updated: 2026-07-01T04:56:48Z published: 2026-07-01T04:56:48Z canonical: "docs.document360.com/how-to-use-swagger" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.document360.com/llms.txt > Use this file to discover all available pages before exploring further. # Comment utiliser Swagger Swagger est un langage de description d’interface qui décrit les API RESTful exprimées à l’aide de JSON. Il vous permet de créer une documentation API interactive, lisible par la machine et par l’humain. Cela vous aide à visualiser et interagir avec les ressources de l’API sans aucune logique d’implémentation. C’est une application web. --- ## Site de documentation Swagger 1. Ouvrez le [site de documentation Swagger](https://apihub.document360.io/). 2. Pour authentifier la documentation, cliquez **sur Autoriser**. Le panneau **des autorisations disponibles** apparaîtra. 3. Entrez le jeton API dans le champ **Value** . > [!NOTE] > NOTE > > Vous pouvez sélectionner un jeton existant, ou en générer un nouveau selon vos besoins. Pour générer un nouveau jeton, suivez les étapes ci-dessous > > - Naviguez dans () dans la barre de navigation de gauche du portail de la base de connaissances. > - Dans le panneau de navigation de gauche, allez au ****Knowledge base portal**** > **Jetons API**. > - Tapez un nom pour le jeton API dans **le nom Saisissez le jeton**. > - Sélectionnez la(s) méthode(s) HTTP requise(s). Vous avez quatre méthodes sous **Permettu(s**) : **GET**, **PUT**, **POST** et **DELETE**. > - Vous ne pouvez utiliser que le jeton généré pour la ou les méthodes sélectionnées. Il ne peut pas être utilisé pour effectuer d’autres méthodes. > - **Cliquez sur Copier** pour copier le jeton API. 4. Cliquez sur le **bouton Autoriser** . 5. Une fois terminé, cliquez sur le bouton **Fermer** . L’autorisation est réalisée avec succès. ![Image showing authorize panel in Swagger](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/17_ScreenShot-Swagger.png) > [!NOTE] > NOTE > > Si vous souhaitez changer de jeton, cliquez **sur Autoriser** > **Déconnexion** > saisissez votre **jeton API** > **Autoriser** > **Fermer**. ### ALLEZ - La méthode **GET** est utilisée pour récupérer des informations. - Voici un exemple d’action **GET** , pour récupérer tous les enregistrements concernant l’utilisateur. ![Image showing GET action in Swagger](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/12_ScreenShot-Swagger_Get.png) 1. Remplissez les champs marqués et cliquez sur le bouton **Exécuter** . Les informations concernant l’utilisateur seront disponibles dans la section **Réponses** . ![Image showing GET action in Swagger](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/13_ScreenShot-Swagger_Get.png) ### POST - La méthode **POST** est utilisée pour ajouter un élément. - Voici un exemple d’action **POST** , pour ajouter un utilisateur à un projet. ![Image showing POST action in Swagger](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/14_ScreenShot-Swagger_Post.png) 1. Vous devez ajouter les informations utilisateur telles que email_id, first_name et last_name pour ajouter un utilisateur au projet. L’utilisateur sera ajouté au projet. 2. Cliquez sur le **bouton Exécuter** . L’ajout de l’utilisateur sera réussi si le statut est de 200 et que le succès est réel. ### PUT - La méthode **PUT** est utilisée pour mettre à jour un élément existant. - Voici un exemple d’action **PUT** , pour mettre à jour un rôle utilisateur dans le projet. ![Image showing PUT action in Swagger](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/15_ScreenShot-Swagger_Put.png) 1. Saisissez **l’userId** dans le champ marqué. 2. Mettez à jour le rôle utilisateur avec le numéro mentionné pour la syntaxe du rôle utilisateur. Les chiffres pour les rôles respectifs sont les suivants : - 1 → Administrateur - 2 → Éditeur - 3 → Rédacteur de brouillons - 4 → lecteur - 7 → Propriétaire 3. Une fois terminé, cliquez sur le bouton **Exécuter** . La mise à jour de l’utilisateur est réussie si le statut est de 200 et que le succès est réel. ### SUPPRIMER - La méthode **DELETE** est utilisée pour supprimer un élément. - Voici un exemple d’action **SUPPRIMER** , pour supprimer un **userId**. 1. Saisissez **l’userId** dans le champ marqué. 2. Une fois terminé, cliquez sur le bouton **Exécuter** . Si le statut est 200 et que le succès est vrai, **l’userId** sera supprimé avec succès. ![Image showing DELETE action in Swagger](https://cdn.document360.io/860f9f88-412e-4570-8222-d5bf2f4b7dd1/Images/Documentation/16_ScreenShot-Swagger_Delete.png) > [!NOTE] > NOTE > > Il est obligatoire d’entrer le contenu marqué ***obligatoire** dans le champ. Pour plus d’informations, consultez les blogs suivants 1. [Guide ultime pour créer une documentation API avec des exemples](https://document360.com/blog/api-documentation/) 2. [Mise en avant des fonctionnalités – API dans Document360](https://www.google.com/search?q=Feature+spotlight+%E2%80%93+API+in+Document360&rlz=1C1CHBD_enIN1119IN1119&oq=Feature+spotlight+%E2%80%93+API+in+Document360&gs_lcrp=EgZjaHJvbWUyBggAEEUYOTIGCAEQRRg80gEHNDI5ajBqN6gCALACAA&sourceid=chrome&ie=UTF-8) --- ### FAQ #### Que dois-je faire si rafraîchir la page met fin à ma session ? Si vous rafraîchez la page, la session peut se terminer, et vous devrez authentifier à nouveau. Suivez les étapes fournies pour l’authentification. #### Comment devrais-je formater des champs qui nécessitent un caractère spécifique ? Vous devez utiliser un underline partout où c’est nécessaire. Par exemple, utilisez « email_id » au lieu de « adresse e-mail ». Utiliser des espaces entraînera une erreur.