Comment faire un appel API en Java ? -Blogue

Salut! En tant que fournisseur d'API, on me demande souvent comment effectuer un appel API en Java. Cela peut paraître un peu intimidant au début, mais une fois que vous avez compris, c'est en fait assez simple. Dans ce blog, je vais vous guider pas à pas tout au long du processus, afin que vous puissiez commencer à effectuer des appels API en Java comme un pro.

Qu'est-ce qu'une API ?

Avant de nous lancer dans les appels d'API en Java, examinons rapidement ce qu'est une API. API signifie Application Programming Interface. Il s'agit d'un ensemble de règles et de protocoles qui permettent à différentes applications logicielles de communiquer entre elles. Considérez-le comme un pont qui permet à votre application Java d'interagir avec des services ou des sources de données externes.

Pourquoi utiliser Java pour les appels API ?

Java est un langage de programmation populaire pour effectuer des appels d'API pour plusieurs raisons. Il est indépendant de la plate-forme, ce qui signifie que vous pouvez écrire votre code une seule fois et l'exécuter sur n'importe quel système d'exploitation. Il dispose également d'une communauté vaste et active, vous pouvez donc facilement trouver des bibliothèques et des ressources pour vous aider dans vos appels API. De plus, le typage puissant de Java et sa nature orientée objet en font un choix fiable et sécurisé pour créer des applications qui interagissent avec les API.

Conditions préalables

Avant de commencer à effectuer des appels d'API en Java, vous aurez besoin de quelques éléments :

Kit de développement Java (JDK): Vous devrez avoir le JDK installé sur votre ordinateur. Vous pouvez le télécharger depuis le site officiel d'Oracle ou utiliser une alternative open source comme OpenJDK.
Environnement de développement intégré (IDE): Un IDE comme IntelliJ IDEA ou Eclipse peut rendre votre processus de développement beaucoup plus facile. Il fournit des fonctionnalités telles que la complétion de code, le débogage et la gestion de projet.
Clé API (si nécessaire): Certaines API nécessitent une clé API pour authentifier vos requêtes. Assurez-vous de disposer de la clé API nécessaire avant de commencer à passer des appels.

Faire un simple appel API en Java

Commençons par effectuer un simple appel d'API vers une API publique. Pour cet exemple, nous utiliserons l'API JSONPlaceholder, qui fournit de fausses données pour les tests et le prototypage.

Tout d'abord, vous devrez ajouter les dépendances nécessaires à votre projet. Si vous utilisez Maven, vous pouvez ajouter la dépendance suivante à votrepom.xmldéposer:

<dependency> <groupId>org.apache.httpcomponents</groupId> <artifactId>httpclient</artifactId> <version>4.5.13</version> </dependency>

Voici le code Java pour effectuer une requête GET à l'API JSONPlaceholder :

importer org.apache.http.HttpResponse ; importer org.apache.http.client.HttpClient ; importer org.apache.http.client.methods.HttpGet ; importer org.apache.http.impl.client.HttpClients ; importer org.apache.http.util.EntityUtils ; importer java.io.IOException ; public class APICallExample { public static void main(String[] args) { try { // Créer un client HTTP HttpClient httpClient = HttpClients.createDefault(); // Créer une requête HTTP GET HttpGet httpGet = new HttpGet("https://jsonplaceholder.typicode.com/posts/1"); // Exécute la requête HttpResponse réponse = httpClient.execute(httpGet); // Récupère le corps de la réponse sous forme de chaîne String réponseBody = EntityUtils.toString(response.getEntity()); // Imprimer le corps de la réponse System.out.println(responseBody); } catch (IOException e) { e.printStackTrace(); } } }

Dans ce code, nous créons d'abord unClient HTTPobjet, qui est utilisé pour envoyer des requêtes HTTP. Ensuite, nous créons unHttpObtenirobjet avec l'URL du point de terminaison de l'API que nous voulons appeler. Nous exécutons la requête en utilisant leexécuterméthode duClient HTTPobjet, puis nous obtenons le corps de la réponse sous forme de chaîne en utilisant leEntityUtils.toStringméthode. Enfin, nous imprimons le corps de la réponse sur la console.

Gestion des réponses API

Une fois que vous avez effectué un appel API, vous devrez gérer la réponse. La réponse d'une API peut être dans différents formats, tels que JSON, XML ou texte brut. Dans la plupart des cas, les API renvoient des données au format JSON, voyons donc comment analyser les réponses JSON en Java.

Vous pouvez utiliser une bibliothèque comme Gson pour analyser les réponses JSON. Tout d'abord, ajoutez la dépendance Gson à votrepom.xmldéposer:

<dependency> <groupId>com.google.code.gson</groupId> <artifactId>gson</artifactId> <version>2.8.8</version> </dependency>

Voici un exemple de la façon d'analyser une réponse JSON à l'aide de Gson :

importer com.google.gson.Gson ; importer org.apache.http.HttpResponse ; importer org.apache.http.client.HttpClient ; importer org.apache.http.client.methods.HttpGet ; importer org.apache.http.impl.client.HttpClients ; importer org.apache.http.util.EntityUtils ; importer java.io.IOException ; importer java.util.Map ; public class JSONParsingExample { public static void main(String[] args) { try { HttpClient httpClient = HttpClients.createDefault(); HttpGet httpGet = new HttpGet("https://jsonplaceholder.typicode.com/posts/1"); Réponse HttpResponse = httpClient.execute(httpGet); Chaîne réponseBody = EntityUtils.toString(response.getEntity()); // Analyse la réponse JSON en utilisant Gson Gson gson = new Gson(); Map<String, Object> jsonMap = gson.fromJson(responseBody, Map.class); // Affiche le titre du message System.out.println("Title: " + jsonMap.get("title")); } catch (IOException e) { e.printStackTrace(); } } }

Dans ce code, nous effectuons d'abord un appel API à l'API JSONPlaceholder et obtenons le corps de la réponse sous forme de chaîne. Ensuite, nous créons unGsonobjet et utiliser sondeJsonméthode pour analyser la chaîne JSON dans unCarteobjet. Enfin, nous imprimons le titre du message en accédant autitreclé dans leCarte.

Faire des requêtes POST

En plus des requêtes GET, vous devrez peut-être également envoyer des requêtes POST à une API. Les requêtes POST sont utilisées pour envoyer des données à une API, par exemple pour créer une nouvelle ressource.

Voici un exemple de la façon de faire une requête POST en Java :

importer org.apache.http.HttpResponse ; importer org.apache.http.client.HttpClient ; importer org.apache.http.client.methods.HttpPost ; importer org.apache.http.entity.StringEntity ; importer org.apache.http.impl.client.HttpClients ; importer org.apache.http.util.EntityUtils ; importer java.io.IOException ; public class PostRequestExample { public static void main(String[] args) { try { HttpClient httpClient = HttpClients.createDefault(); HttpPost httpPost = new HttpPost("https://jsonplaceholder.typicode.com/posts"); // Définit le corps de la requête String json = "{\"title\": \"foo\", \"body\": \"bar\", \"userId\": 1}"; Entité StringEntity = new StringEntity(json); httpPost.setEntity(entité); httpPost.setHeader("Type de contenu", "application/json"); // Exécute la requête HttpResponse réponse = httpClient.execute(httpPost); Chaîne réponseBody = EntityUtils.toString(response.getEntity()); // Imprimer le corps de la réponse System.out.println(responseBody); } catch (IOException e) { e.printStackTrace(); } } }

Dans ce code, nous créons d'abord unHttpPostobjet avec l'URL du point de terminaison de l'API que nous voulons appeler. Ensuite, nous définissons le corps de la requête en créant unChaîneEntitéobjet et en le définissant comme l'entité duHttpPostobjet. Nous avons également fixé leType de contenuen-tête versapplication/jsonpour indiquer que nous envoyons des données JSON. Enfin, nous exécutons la requête et imprimons le corps de la réponse.

0.5mm High-Efficiency Preparation Plate Preparation Plate PLC Silica Gel Plate Large Size 200*200mm 3-BUTYL-2-(1-ETHYLPENTYL)OXAZOLIDINE CAS NO 165101-57-5

Nos offres API

En tant que fournisseur d'API, nous proposons une large gamme d'API pour différents secteurs et cas d'utilisation. Que vous recherchiezPanneau de préparation Standard 1mm,1.5mm,2mm, panneau PLC Standard, plaque de gel de silice Standard, taille 200x200m,3-BUTYL-2-(1-ÉTHYLPENTYL)OXAZOLIDINE CAS NO 165101-57-5, ouPlaque de préparation de Gel de silice PLC, plaque de préparation à haute efficacité de 0.5mm,1mm,1.5mm,2mm, grande taille 200x200mm, nous avons ce qu'il vous faut.

Nos API sont conçues pour être faciles à utiliser et à intégrer dans vos applications existantes. Nous fournissons une documentation détaillée et une assistance pour vous aider à démarrer rapidement. Si vous souhaitez utiliser nos API, n'hésitez pas à nous contacter pour un essai gratuit ou pour discuter de vos besoins spécifiques.

Conclusion

Effectuer des appels API en Java est une compétence précieuse qui peut ouvrir un monde de possibilités pour vos applications. En suivant les étapes décrites dans ce blog, vous devriez maintenant bien comprendre comment effectuer des appels d'API en Java, gérer les réponses et effectuer des requêtes POST.

Si vous avez des questions ou avez besoin d'aide supplémentaire, n'hésitez pas à nous contacter. Nous sommes là pour vous aider à tirer le meilleur parti de nos API et à faire passer vos applications au niveau supérieur.