Explorer l’API REST du serveur JIRA via Postman

Importance de Jira Automation

L’automatisation des projets dans Jira est nécessaire car elle permet de gagner du temps, d’augmenter la productivité et d’améliorer la coopération des équipes. Dans ce Blog, je vais vous apprendre à automatiser diverses activités dans Jira, en réduisant votre charge de travail et en vous fournissant un rapport détaillé. Ce qui vous permettra également de vous concentrer sur d’autres aspects importants.

« Concentrez-vous sur les choses importantes. Laissez l’automatisation faire le reste.

Qu’est-ce que JIRA

JIRA est un Outil de test logiciel/suivi des bogues développé par la société australienne Atlassian. Jira a gagné en popularité au fil du temps, avec plus de 180 000 utilisateurs dans 190 des pays. C’est un logiciel de suivi des bogues qui permet également une gestion de projet agile.

Attendre API REST sont utilisés pour se connecter à distance à Applications serveur Jira. La plate-forme Jira Server fournit une API REST pour les fonctionnalités de base telles que les problèmes et les flux de travail, ou vous pouvez développer tout autre type d’interface.

Projets: Il sert à gérer très efficacement les défauts.

Publier: Il est utilisé pour suivre et gérer les défauts/problèmes.

Flux de travail: traite le cycle de vie des problèmes/défauts.

Chercher: Trouvez facilement. Grâce à Jira, nous pouvons savoir ce qui s’est passé dans les versions précédentes et combien de défauts se sont produits dans les projets précédents.

Tableaux de bord: Un tableau de bord est un affichage que vous voyez lorsque vous vous connectez à Jira pour suivre les affectations et les problèmes sur lesquels vous travaillez.

Qu’est-ce que l’automatisation

L’automatisation vous permet de vous concentrer sur le travail important en Éliminer Le besoin de Tâches manuelles et répétitives et veiller à ce qu’il respecte des normes strictes. Ce Chèques pour les bogues, les défauts et tout autre problème pouvant survenir lors de la création d’un produit.

Parce que ça marche Rapidement et efficacement, il peut réduire considérablement le temps nécessaire pour évaluer les produits. Les développeurs et les responsables de production auront plus de temps libre, qu’ils pourront consacrer à d’autres éléments du projet. En conséquence, il peut considérablement Augmentation de la productivité.

Automatiser Jira

Utilisation des API Jira telles que API REST et API Java, vous pouvez étendre la capacité de Jira pour répondre aux besoins de votre entreprise. Alors, êtes-vous prêt à plonger plus profondément dans les API Jira ? Si c’est le cas, Commençons. Ce blog vous en apprendra plus sur Jira et vous montrera comment utiliser ses capacités fantastiques.

Vous pouvez utiliser ceci Documentation API REST à Créer des modules complémentaires pour JIRA, développer des intégrations entre JIRA et d’autres applications, ou des interactions de script avec JIRA.

De plus, nous devons nous assurer que nous utilisons le serveur JIRA, nous devons donc compter sur API du serveur JIRA et non le nuage. Référez-vous donc au lien ci-dessous car nous interagirons avec notre serveur JIRA à partir d’une machine locale. Avec l’aide d’un lienvous pouvez jouer en cliquant sur les liens et en obtenant la réponse remplie avec le logiciel hôte local.

Structure d’URI

Les API REST de JIRA permettent d’accéder aux ressources (entités de données) via des chemins URI. Pour utiliser une API REST, votre application fera une requête HTTP et analysera la réponse. L’API JIRA REST utilise JSON que son format de communication et la norme Méthodes HTTP comme GET, PUT, POST et DELETE.

http://host:port/context/rest/api-name/api-version/resource-name

Après avoir atteint chaque API, vous pouvez vérifier la réponse en affirmant le code de réponse que nous avons récupéré. Quelques-uns d’entre eux qui sont largement utilisés sont énumérés ci-dessous:

Code et description

• 1xx : informatif: La demande a été reçue et le processus se poursuit.
• 2xx : Succès signifie que l’action a été reçue, comprise et acceptée avec succès.
• 3xx : redirection: Des mesures supplémentaires doivent être prises pour compléter la demande.
• 4xx : erreur client: La demande contient une syntaxe incorrecte ou ne peut pas être satisfaite.
• 5xx : erreur de serveur: Le serveur n’a pas réussi à répondre à une demande apparemment valide.

Structure de réponse JSON

1. Demande réussie :

{

« succès »: vrai,

« charge utile »: {

/* Les données spécifiques à l’application iraient ici. */

}

}

2. Échec de la demande :

{

« succès »: faux,

« charge utile »: {

/* Les données spécifiques à l’application iraient ici. */

},

« Erreur »: {

« code » : 123,

« message » : « Une erreur s’est produite ! »

}

}

Création d’une nouvelle session et stockage de la clé

Étape 1:

Comme nous utilisons le serveur JIRA, ouvrez postman et cliquez sur l’URL :

http://localhost:8000/rest/auth/1/session

Étape 2:

Allez sous la section Body et sélectionnez « raw » et sélectionnez JSON (application/JSON)

Sous ceci, entrez vos informations d’identification d’utilisateur dans le format suivant

{« nom d’utilisateur »: « monutilisateur », « mot de passe »: « monmotdepasse »}

Étape 3:

Vérifiez la création d’une nouvelle session et renvoyez les informations de session demandées, qui ressembleront à ceci :

{

« session »:

{

« nom »: »exemple.cookie.nom »,

« valeur »: « 6E3487971234567896704A9EB4AE501F »

}

}

Conclusion: Félicitations, vous vous êtes connecté avec succès à l’application et Création d’une session aussi bien.

Et maintenant, nous sommes tous prêts à effectuer des opérations sur le compte à l’aide du cookie de session. Essayons quelques-unes des opérations essentielles que nous pouvons utiliser sur JIRA à l’aide des API REST.

Créer un problème

Crée un problème ou une sous-tâche à partir d’une représentation JSON. Veuillez regarder le lien contenant toutes les données et les étapes pour créer un nouveau problème. Les données nous sont fournies par le Documentation Atlassienne.

Nous devons utiliser une requête POST pour créer un problème. Et le lien que nous devons utiliser est /rest/api/2/problème.

Étape 1:

Comme nous utilisons le serveur JIRA, ouvrez postman et entrez l’URL :

http://localhost:8000/rest/api/2/issue

Étape 2:

Sélectionnez le « PUBLIER » méthode

Étape 3:

Allez sous la section Body, sélectionnez « raw » et sélectionnez JSON (application/JSON) à la place de Text

{

« des champs:

{

« projet »:

{

« clé »: « RES »//projectKey

},

« résumé »: « Défaut survenu »,

« description »: « C’est mon premier bug »,

« type de probleme »: {

« nom »: « Bug »

}

}

}

Étape 4:

Accédez à l’onglet En-têtes et entrez la clé en tant que « Cookie » et la valeur en tant que JSESSIONID = « yourSessionKey ».

Étape 5 :

Vérifiez que vous obtenez la réponse de la manière suivante :

{

« identifiant »: « 1001 »,

« clé »: « RES-1 »,

« soi »: « http://localhost:8000/rest/api/2/issue/1001”

}

Conclusion: Félicitations, vous avez créé avec succès votre premier bogue à l’aide de l’API REST.

Supprimer le problème

L’API de suppression est utilisée pour supprimer un problème existant.

Étape 1:

Ouvrez le facteur et entrez l’URL :

http://localhost:8000/rest/api/2/issue/{issueIdOrKey}

Étape 2:

Sélectionnez le « EFFACER » méthode

Étape 3:

Accédez à l’onglet En-têtes et entrez la clé en tant que « Cookie » et la valeur en tant que JSESSIONID = « yourSessionKey ».

Étape 4:

Vérifiez que le code d’état que nous avons obtenu est 204

Conclusion: Félicitations, vous venez de supprimer un problème à l’aide de l’API Rest.

Remarque : Comme vous l’avez remarqué, nous touchons à peine au tableau de bord JIRA et notre demande d’API fonctionne pour nous.

Ajouter un commentaire

L’API Ajouter un commentaire est chargée d’ajouter un nouveau commentaire à un problème.

Étape 1:

Ouvrez le facteur et entrez l’URL :

http://localhost:8000/rest/api/2/issue/{issueIdOrKey}/comment

Étape 2:

Sélectionnez la méthode « POST »

Étape 3:

Allez sous la section Body, sélectionnez « raw » et sélectionnez JSON (application/JSON) à la place de Text

Étape 4:

Entrez la valeur ci-dessous

{

« body »: « Bonjour, ceci est mon premier commentaire de l’API REST »,

« visibilité »: {

« type »: « rôle »,

« valeur »: « Administrateurs »

}

}

Étape 5 :

Accédez à l’onglet En-têtes, entrez la clé en tant que « Cookie » et la valeur JSESSIONID = « yourSessionKey ».

Étape 6 :

Vérifiez que le code d’état que nous avons reçu est « 201 ». Cela signifie que le commentaire a été ajouté avec succès.

Conclusion: Félicitations, vous avez ajouté un commentaire avec succès à l’aide de l’API REST.

Mettre à jour le commentaire

Met à jour un commentaire existant à l’aide de sa représentation JSON :

Étape 1:

Ouvrez le facteur et entrez l’URL :

http://localhost:8000/rest/api/2/issue/{issueIdOrKey}/comment/{id}

Remarque : Vous obtiendrez l’ID de commentaire lorsqu’il sera généré à partir de la réponse JSON reçue.

Étape 2:

Sélectionnez la méthode « PUT »

Étape 3:

Allez sous la section Body, sélectionnez « raw » et sélectionnez JSON (application/JSON) à la place de Text

Étape 4:

Entrez la valeur ci-dessous

{

« body »: « Bonjour, ceci est mon commentaire mis à jour de l’API REST »,

« visibilité »: {

« type »: « rôle »,

« valeur »: « Administrateurs »

}

}

Étape 5 :

Accédez à l’onglet En-têtes et entrez la clé en tant que « Cookie » et la valeur en tant que JSESSIONID = « yourSessionKey »

Étape 6 :

Vérifiez que le code d’état que nous avons reçu est « 200 ». Cela signifie que le commentaire a été mis à jour avec succès.

Conclusion: Félicitations, vous avez mis à jour avec succès votre commentaire existant à l’aide de l’API REST.

Conclusion: Nous connaissons maintenant JIRA et l’automatisons à l’aide des API REST pour effectuer les opérations POST, PUT, DELETE et GET. Principes de base de la structure de réponse JSON. Plus précisément, vous avez appris la Principales caractéristiques de Jira qui le rendent si populaire parmi les développeurs. De plus, vous avez compris les étapes détaillées pour travailler avec API Jira.

Bon codage !