Allgemeine Informationen zu der Klasse
Diese Klasse repräsentiert die Responses, welche von der API an den Webclient gesendet werden.
1. Beispiel (mit einem String als Info):
"response": {
"statusCode": "200",
"description": "Success",
"requestedURL": "URL"
"content": {
"text/plain": {
"info": "Rückmeldung von dem jeweiligen Use Cases"
}
}
}
2. Beispiel (mit einem Objekt als Rückgabetyp):
"response": {
"statusCode": "200",
"description": "Success",
"requestedURL": "URL"
"content": {
"application/json":
{ Objekt, das zurückgesendet werden soll }
}
}
Methoden in der Klasse
- +init(self, status_code: StatusCodes, data, content_type="text/plain")
- +to_json()
Nähere Beschreibung der einzelnen Methoden
init(self, status_code: StatusCodes, data, content_type="text/plain")
- Soll ein String zurückgesendet werden, wird das Objekt mit zwei Parametern (Status Code und data) initialisiert. Data enthält den String.
Sollte man jedoch ein Objekt zurückschicken wollen, wird das Objekt mit drei Parametern initialisiert: Status Code, data enthält das Objekt und als content_type wird "application/json" angegeben.
to_json()
- Wandelt ein Python Dictionary-Objekt in ein JSON-Objekt um und gibt es zurück.