Arbeitsschritte

API - Was ist das?

Es gibt verschiedene Arten von APIs, darunter Web APIs, Bibliotheks-APIs und Betriebssystem-APIs. Web APIs sind besonders verbreitet und ermöglichen die Kommunikation zwischen verschiedenen Anwendungen über das Internet. Sie basieren oft auf standardisierten Protokollen wie HTTP und können verschiedene Datenformate wie JSON oder XML verwenden.

Eine API stellt normalerweise eine Sammlung von definierten Schnittstellen und Funktionen bereit, die von Entwicklern genutzt werden können, um auf bestimmte Dienste oder Ressourcen zuzugreifen. Eine solche Sammlung kann u.a. mit Hilfe von OpenAPI dokumentiert werden. Diese Dokumentationshilfe wird uns in diesem Kapitel dabei helfen, Schnittstellen anzusprechen und zu testen.

• 1 Werfen Sie einen Blick in ein beliebiges OpenAPI Projekt. Welche HTTP-Methoden finden Sie dort wieder?

RESTful-API

Eine RESTful-API hat besondere Eigenschaften, die wir uns hier genauer anschauen. Recherchieren Sie auf der RESTful-API-Seite:

• 2 Was zeichnet eine RESTful-API Architektur aus?
• 3 Was sind die 6 grundlegenden Prinzipien?
• 4 Wie sieht ein REST-Endpunkt aus und werden Ressourcen-Endpunkte in Singular oder Plural bezeichnet?
• 5 Worin unterscheiden sich PUT und POST? Erstellen Sie jeweils ein Beispiel, um den Unterschied zu verdeutlichen.
• 6 Sind REST udn HTTP gleichzusetzen?

Python Request - Wofür benötige ich das?

Das requests-Modul ist eine externe Bibliothek für Python, die die Arbeit mit HTTP-Anfragen vereinfacht. Es bietet eine einfach zu bedienende API für das Senden von HTTP-Anfragen und das Verarbeiten von HTTP-Antworten. Um die Petstore-Schnittstellen abzufragen, verwenden Sie das requests-Modul in Python.

• 1 Wenn Sie das Paket noch nicht installiert haben, können Sie es mit folgendem Befehl pip install requests nachholen.

Petstore kennenlernen

Für die kommenden Aufgaben werden wir die freie API Petstore verwenden, die uns unter swagger.io zur Verfügung steht. Machen Sie sich mit der Navigation und der Beschreibung des Petstores vertraut. Lesen Sie den Artikel REST Web Services und beantworten Sie folgende Fragen:

• 7 Was versteht man unter REST?
• 8 Kann ich einen POST Request über einen Webbrowser absetzen?

Petstore-Schnittstellen verwenden

Jetzt widmen wir uns den praktischen Aufgaben zu. nachdem Sie einen Blick in die Petstore-Dokumentation geworfen haben, sind Ihnen bestimmt auch verschiedene Schnittstellen aufgefallen. Diese nutzen wir jetzt, um Informationen zu erhalten.

• 2 Nutzen Sie folgendes Script, um eine API Anfrage zu senden. Kommentieren und beschreiben Sie die enthaltenen TODOs:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

# todo 1
import requests

def get_pet_data():
    # todo 2
    api_url = "https://petstore.swagger.io/v2/pet/findByStatus?status=available"

    try:
        # todo 3
        response = requests.get(api_url)

        # todo 4
        if response.status_code == 200:
            # todo 5
            pet_data = response.json()
            print("Available pets:")
            print(pet_data)
        else:
            print(f"Fehler bei der Anfrage. Statuscode: {response.status_code}")
    except Exception as e:
        print(f"Fehler bei der Anfrage: {str(e)}")

if __name__ == "__main__":
    get_pet_data()

• 3 Im folgenden POST Request ist ein Fehler unterlaufen. Korrigieren Sie das Problem und Beschreiben Sie die Rückgabe (JSON Response).

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

import requests

def create_pet():
    # URL der API
    api_url = "https://petstore.swagger.io/v2/pet"

    # Beispiel-Daten für den POST-Request (Sie können diese Daten anpassen)
    pet_data = {
        "id": 12345,
        "name": "Fluffy",
        "category": {
            "id": 1,
            "name": "Cats"
        },
        "photoUrls": [
            "https://example.com/fluffy.jpg"
        ],
        "tags": [
            {
                "id": 1,
                "name": "cute"
            }
        ],
        "status": "available"
    }

    try:
        # POST-Anfrage an die API senden
        response = requests.post(api_url, json=pet_data)

        # Überprüfen Sie den Statuscode der Antwort
        if response.status_code == 200:
            # Die Antwort als JSON-Daten analysieren
            created_pet_data = response.json()
            print("Pet erfolgreich erstellt. Neue Daten:")
            print(created_pet_data)
        else:
            print(f"Fehler bei der Anfrage. Statuscode: {response.status_code}")
    except Exception as e:
        print(f"Fehler bei der Anfrage: {str(e)}")

if __name__ == "__main__":
    create_pet()

• 1 Erstellen Sie ein Update und ein Delete Request für eine beliebige existierende Pet-ID (Suchen Sie eigenständig nach einem vorhandenen Eintrag.)