Documentation

P1 Schnittstelle¶

Code beispiel:

Name & Main

from flask import Flask, request, jsonify

app = Flask(__name__)

@app.route('/summe', methods=['GET'])
def summe():
    a = request.args.get('a', default=0, type=float)
    b = request.args.get('b', default=0, type=float)
    name = request.args.get('name', default='unbekannt')

    summe = a + b

    return jsonify({"name": name, "summe": summe})

if __name__ == '__main__':
    app.run(host='0.0.0.0', port=5000)

py- Datei ihres Dienstes in Code-Fence mit beanworteten Fragen:¶

1. Was wird in Pyhton mit `name` und `main` gesteuert?
Wie ist Ihr JSON-Objekt aufgebaut? Wie könnten Sie es um weitere Parameter ergänzen?¶

In Python wird ```__name__``` verwendet um zu steurn, ob ein Skript direkt ausgeführt wird oder ob es als Modul impotiert wird.
Wenn ein Skript direkt ausgeführt wird, hat ```__name__```den Wert ```__main__``` .
Dies ermöglicht es, bestimmte Teile des Codes nur dann auszuführen, wenn das Skript direkt gestartet wird, und nicht, wenn es in anderes Skript impotiert wird.

2. Wie ist Ihr JSON-Objekt aufgebaut? Wie könnten Sie es um weitere Parameter ergänzen?¶

Json Aufbau

Das JSON-Objekt, das von der Flask-Anwendung zurückgegeben wird, hat folgendes Format:

{
"name": "unbekannt",
"summe": 0
}

Dieses Objekt enthält zwei Schlüssel: name der den Wert des Parameters name enthält, und summe, der die Summe der Parameter a und b darstellt.

3. Begrifflichkeiten klären: Was ist eine API? Wozu eine Schnittstellendeklaration?¶

Was ist eine API?

Eine API (Application Programming Interface) ist eine Schnittstelle, die es verschiedenen Softwareanwendungen ermöglicht, miteinander zu kommunizieren.
Sie definiert Methoden und Datenstrukturen, die von den Anwendungen verwendet werden können, um Daten oder Funktionen zu teilen.
Eine Schnittstellendeklaration ist eine formale Beschreibung dieser Methoden und Datenstrukturen, die festlegt, wie andere Programme mit der API interagieren können.

4. Dokumentierter Zugriff auf Ihren Dienst von anderem Knoten des VS (Screenshot, Erklärung) + Screenshot von Ihrer eigenen Schnittstellendokumentation¶

Step	Description
1	als erstes den Befehl `python3 code.py`, das bedeutet, dass ich den datei code.py ausführen möchte. Danach auf diesen gelben link drauf klicken und in Browser öffnen
2	danach füllen wir die restlichen URL aus mit `/summe?a=2&b=4&name=efe`
3	Danach solltest du ein anderes Gerät an den selben Internet verbinden und denn gleichen URL eingeben, am Anfang des URLs steht der Ip adresse des rasperys