Hallo! Als API-Anbieter werde ich oft gefragt, wie man einen API-Aufruf in Java durchführt. Es mag auf den ersten Blick etwas entmutigend wirken, aber sobald man den Dreh raus hat, ist es eigentlich ganz einfach. In diesem Blog werde ich Sie Schritt für Schritt durch den Prozess führen, damit Sie wie ein Profi mit der Durchführung von API-Aufrufen in Java beginnen können.
Was ist eine API?
Bevor wir uns mit der Durchführung von API-Aufrufen in Java befassen, werfen wir einen kurzen Blick darauf, was eine API ist. API steht für Application Programming Interface. Dabei handelt es sich um eine Reihe von Regeln und Protokollen, die es verschiedenen Softwareanwendungen ermöglichen, miteinander zu kommunizieren. Betrachten Sie es als eine Brücke, die es Ihrer Java-Anwendung ermöglicht, mit externen Diensten oder Datenquellen zu interagieren.
Warum Java für API-Aufrufe verwenden?
Java ist aus mehreren Gründen eine beliebte Programmiersprache für API-Aufrufe. Es ist plattformunabhängig, was bedeutet, dass Sie Ihren Code einmal schreiben und ihn auf jedem Betriebssystem ausführen können. Es verfügt außerdem über eine große und aktive Community, sodass Sie leicht Bibliotheken und Ressourcen finden können, die Sie bei Ihren API-Aufrufen unterstützen. Darüber hinaus ist Java aufgrund seiner starken Typisierung und Objektorientierung eine zuverlässige und sichere Wahl für die Erstellung von Anwendungen, die mit APIs interagieren.
Voraussetzungen
Bevor Sie mit der Durchführung von API-Aufrufen in Java beginnen, benötigen Sie einige Dinge:
- Java Development Kit (JDK): Sie müssen das JDK auf Ihrem Computer installiert haben. Sie können es von der offiziellen Oracle-Website herunterladen oder eine Open-Source-Alternative wie OpenJDK verwenden.
- Integrierte Entwicklungsumgebung (IDE): Eine IDE wie IntelliJ IDEA oder Eclipse kann Ihren Entwicklungsprozess erheblich vereinfachen. Es bietet Funktionen wie Code-Vervollständigung, Debugging und Projektmanagement.
- API-Schlüssel (falls erforderlich): Einige APIs erfordern einen API-Schlüssel zur Authentifizierung Ihrer Anfragen. Stellen Sie sicher, dass Sie über den erforderlichen API-Schlüssel verfügen, bevor Sie mit dem Tätigen von Anrufen beginnen.
Einen einfachen API-Aufruf in Java durchführen
Beginnen wir mit einem einfachen API-Aufruf an eine öffentliche API. Für dieses Beispiel verwenden wir die JSONPlaceholder-API, die gefälschte Daten zum Testen und Prototyping bereitstellt.
Zunächst müssen Sie Ihrem Projekt die erforderlichen Abhängigkeiten hinzufügen. Wenn Sie Maven verwenden, können Sie die folgende Abhängigkeit zu Ihrem hinzufügenpom.xmlDatei:
<dependency> <groupId>org.apache.httpcomponents</groupId> <artifactId>httpclient</artifactId> <version>4.5.13</version> </dependency>
Hier ist der Java-Code, um eine GET-Anfrage an die JSONPlaceholder-API zu stellen:
import org.apache.http.HttpResponse; import org.apache.http.client.HttpClient; import org.apache.http.client.methods.HttpGet; import org.apache.http.impl.client.HttpClients; import org.apache.http.util.EntityUtils; import java.io.IOException; public class APICallExample { public static void main(String[] args) { try { // Einen HTTP-Client erstellen HttpClient httpClient = HttpClients.createDefault(); // Erstellen Sie eine HTTP-GET-Anfrage HttpGet httpGet = new HttpGet("https://jsonplaceholder.typicode.com/posts/1"); // Anfrage ausführen HttpResponse Response = httpClient.execute(httpGet); // Antworttext als String abrufen String ResponseBody = EntityUtils.toString(response.getEntity()); // Den Antworttext drucken System.out.println(responseBody); } Catch (IOException e) { e.printStackTrace(); } } }
In diesem Code erstellen wir zunächst eineHttpClientObjekt, das zum Senden von HTTP-Anfragen verwendet wird. Dann erstellen wir eineHttpGet-Objekt mit der URL des API-Endpunkts, den wir aufrufen möchten. Wir führen die Anfrage mit dem ausausführenMethode derHttpClientObjekt, und dann erhalten wir den Antworttext als Zeichenfolge mithilfe vonEntityUtils.toStringVerfahren. Zum Schluss geben wir den Antworttext auf der Konsole aus.
Umgang mit API-Antworten
Sobald Sie einen API-Aufruf durchgeführt haben, müssen Sie die Antwort verarbeiten. Die Antwort einer API kann in verschiedenen Formaten vorliegen, z. B. JSON, XML oder Nur-Text. In den meisten Fällen geben APIs Daten im JSON-Format zurück. Schauen wir uns also an, wie man JSON-Antworten in Java analysiert.
Sie können eine Bibliothek wie Gson verwenden, um JSON-Antworten zu analysieren. Fügen Sie zunächst die Gson-Abhängigkeit zu Ihrem hinzupom.xmlDatei:
<dependency> <groupId>com.google.code.gson</groupId> <artifactId>gson</artifactId> <version>2.8.8</version> </dependency>
Hier ist ein Beispiel für das Parsen einer JSON-Antwort mit Gson:
import com.google.gson.Gson; import org.apache.http.HttpResponse; import org.apache.http.client.HttpClient; import org.apache.http.client.methods.HttpGet; import org.apache.http.impl.client.HttpClients; import org.apache.http.util.EntityUtils; import java.io.IOException; java.util.Map importieren; öffentliche Klasse JSONParsingExample { public static void main(String[] args) { try { HttpClient httpClient = HttpClients.createDefault(); HttpGet httpGet = new HttpGet("https://jsonplaceholder.typicode.com/posts/1"); HttpResponse-Antwort = httpClient.execute(httpGet); String ResponseBody = EntityUtils.toString(response.getEntity()); // JSON-Antwort mit Gson analysieren Gson gson = new Gson(); Map<String, Object> jsonMap = gson.fromJson(responseBody, Map.class); // Den Titel des Beitrags drucken System.out.println("Title: " + jsonMap.get("title")); } Catch (IOException e) { e.printStackTrace(); } } }
In diesem Code führen wir zunächst einen API-Aufruf an die JSONPlaceholder-API durch und erhalten den Antworttext als Zeichenfolge. Dann erstellen wir eineGsonObjekt und verwenden Sie esvonJsonMethode zum Parsen der JSON-Zeichenfolge in eineKarteObjekt. Abschließend drucken wir den Titel des Beitrags aus, indem wir auf zugreifenTitelGeben Sie den Schlüssel einKarte.
POST-Anfragen stellen
Zusätzlich zu GET-Anfragen müssen Sie möglicherweise auch POST-Anfragen an eine API stellen. POST-Anfragen werden verwendet, um Daten an eine API zu senden, beispielsweise zum Erstellen einer neuen Ressource.
Hier ist ein Beispiel für die Durchführung einer POST-Anfrage in Java:
import org.apache.http.HttpResponse; import org.apache.http.client.HttpClient; import org.apache.http.client.methods.HttpPost; import org.apache.http.entity.StringEntity; import org.apache.http.impl.client.HttpClients; import org.apache.http.util.EntityUtils; import java.io.IOException; öffentliche Klasse PostRequestExample { public static void main(String[] args) { try { HttpClient httpClient = HttpClients.createDefault(); HttpPost httpPost = new HttpPost("https://jsonplaceholder.typicode.com/posts"); // Anforderungstext festlegen String json = "{\"title\": \"foo\", \"body\": \"bar\", \"userId\": 1}"; StringEntity-Entity = new StringEntity(json); httpPost.setEntity(entity); httpPost.setHeader("Content-type", "application/json"); // Anfrage ausführen HttpResponse Response = httpClient.execute(httpPost); String ResponseBody = EntityUtils.toString(response.getEntity()); // Den Antworttext drucken System.out.println(responseBody); } Catch (IOException e) { e.printStackTrace(); } } }
In diesem Code erstellen wir zunächst eineHttpPost-Objekt mit der URL des API-Endpunkts, den wir aufrufen möchten. Dann legen wir den Anforderungstext fest, indem wir eine erstellenStringEntityObjekt und setzt es als Entität desHttpPostObjekt. Wir stellen auch die einInhaltstypKopfzeile zuapplication/jsonum anzuzeigen, dass wir JSON-Daten senden. Abschließend führen wir die Anfrage aus und drucken den Antworttext aus.


Unsere API-Angebote
Als API-Anbieter bieten wir eine breite Palette an APIs für verschiedene Branchen und Anwendungsfälle. Ob Sie suchen1 mm, 1,5 mm, 2 mm Standard-Vorbereitungsplatine Standard-SPS-Platine Standard-Kieselgelplatte Größe 200*200 m,3-BUTYL-2-(1-ETHYLPENTYL)OXAZOLIDIN CAS-NR. 165101-57-5, oder0,5 mm, 1 mm, 1,5 mm, 2 mm Hocheffiziente Vorbereitungsplatte PLC-Kieselgelplatte Vorbereitungsplatte Große Größe 200 * 200 mm, wir sind für Sie da.
Unsere APIs sind so konzipiert, dass sie einfach zu verwenden und in Ihre vorhandenen Anwendungen integrierbar sind. Wir bieten detaillierte Dokumentation und Support, um Ihnen einen schnellen Einstieg zu ermöglichen. Wenn Sie an der Nutzung unserer APIs interessiert sind, zögern Sie nicht, uns für eine kostenlose Testversion zu kontaktieren oder Ihre spezifischen Anforderungen zu besprechen.
Abschluss
Das Ausführen von API-Aufrufen in Java ist eine wertvolle Fähigkeit, die Ihren Anwendungen eine Welt voller Möglichkeiten eröffnen kann. Wenn Sie die in diesem Blog beschriebenen Schritte befolgen, sollten Sie nun ein gutes Verständnis dafür haben, wie Sie API-Aufrufe in Java durchführen, Antworten verarbeiten und POST-Anfragen stellen.
Wenn Sie Fragen haben oder weitere Hilfe benötigen, können Sie sich gerne an uns wenden. Wir sind hier, um Ihnen dabei zu helfen, das Beste aus unseren APIs herauszuholen und Ihre Anwendungen auf die nächste Stufe zu bringen.
Referenzen
- Apache HttpClient-Dokumentation
- Gson-Dokumentation
- JSONPlaceholder API-Dokumentation