|
| 1 | +# Response-Statuscode |
| 2 | + |
| 3 | +So wie ein Responsemodell, können Sie auch einen HTTP-Statuscode für die Response deklarieren, mithilfe des Parameters `status_code`, und zwar in jeder der *Pfadoperationen*: |
| 4 | + |
| 5 | +* `@app.get()` |
| 6 | +* `@app.post()` |
| 7 | +* `@app.put()` |
| 8 | +* `@app.delete()` |
| 9 | +* usw. |
| 10 | + |
| 11 | +```Python hl_lines="6" |
| 12 | +{!../../../docs_src/response_status_code/tutorial001.py!} |
| 13 | +``` |
| 14 | + |
| 15 | +!!! note "Hinweis" |
| 16 | + Beachten Sie, dass `status_code` ein Parameter der „Dekorator“-Methode ist (`get`, `post`, usw.). Nicht der *Pfadoperation-Funktion*, so wie die anderen Parameter und der Body. |
| 17 | + |
| 18 | +Dem `status_code`-Parameter wird eine Zahl mit dem HTTP-Statuscode übergeben. |
| 19 | + |
| 20 | +!!! info |
| 21 | + Alternativ kann `status_code` auch ein `IntEnum` erhalten, so wie Pythons <a href="https://docs.python.org/3/library/http.html#http.HTTPStatus" class="external-link" target="_blank">`http.HTTPStatus`</a>. |
| 22 | + |
| 23 | +Das wird: |
| 24 | + |
| 25 | +* Diesen Statuscode mit der Response zurücksenden. |
| 26 | +* Ihn als solchen im OpenAPI-Schema dokumentieren (und somit in den Benutzeroberflächen): |
| 27 | + |
| 28 | +<img src="/img/tutorial/response-status-code/image01.png"> |
| 29 | + |
| 30 | +!!! note "Hinweis" |
| 31 | + Einige Responsecodes (siehe nächster Abschnitt) kennzeichnen, dass die Response keinen Body hat. |
| 32 | + |
| 33 | + FastAPI versteht das und wird in der OpenAPI-Dokumentation anzeigen, dass es keinen Responsebody gibt. |
| 34 | + |
| 35 | +## Über HTTP-Statuscodes |
| 36 | + |
| 37 | +!!! note "Hinweis" |
| 38 | + Wenn Sie bereits wissen, was HTTP-Statuscodes sind, überspringen Sie dieses Kapitel und fahren Sie mit dem nächsten fort. |
| 39 | + |
| 40 | +In HTTP senden Sie als Teil der Response einen aus drei Ziffern bestehenden numerischen Statuscode. |
| 41 | + |
| 42 | +Diese Statuscodes haben einen Namen zugeordnet, um sie besser zu erkennen, aber der wichtige Teil ist die Zahl. |
| 43 | + |
| 44 | +Kurz: |
| 45 | + |
| 46 | +* `100` und darüber stehen für „Information“. Diese verwenden Sie selten direkt. Responses mit diesen Statuscodes können keinen Body haben. |
| 47 | +* **`200`** und darüber stehen für Responses, die „Successful“ („Erfolgreich“) waren. Diese verwenden Sie am häufigsten. |
| 48 | + * `200` ist der Default-Statuscode, welcher bedeutet, alles ist „OK“. |
| 49 | + * Ein anderes Beispiel ist `201`, „Created“ („Erzeugt“). Wird in der Regel verwendet, wenn ein neuer Datensatz in der Datenbank erzeugt wurde. |
| 50 | + * Ein spezieller Fall ist `204`, „No Content“ („Kein Inhalt“). Diese Response wird verwendet, wenn es keinen Inhalt gibt, der zum Client zurückgeschickt wird, diese Response hat also keinen Body. |
| 51 | +* **`300`** und darüber steht für „Redirection“ („Umleitung“). Responses mit diesen Statuscodes können einen oder keinen Body haben, mit Ausnahme von `304`, „Not Modified“ („Nicht verändert“), welche keinen haben darf. |
| 52 | +* **`400`** und darüber stehen für „Client error“-Responses („Client-Fehler“). Auch diese verwenden Sie am häufigsten. |
| 53 | + * Ein Beispiel ist `404`, für eine „Not Found“-Response („Nicht gefunden“). |
| 54 | + * Für allgemeine Fehler beim Client können Sie einfach `400` verwenden. |
| 55 | +* `500` und darüber stehen für Server-Fehler. Diese verwenden Sie fast nie direkt. Wenn etwas an irgendeiner Stelle in Ihrem Anwendungscode oder im Server schiefläuft, wird automatisch einer dieser Fehler-Statuscodes zurückgegeben. |
| 56 | + |
| 57 | +!!! tip "Tipp" |
| 58 | + Um mehr über Statuscodes zu lernen, und welcher wofür verwendet wird, lesen Sie die <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" class="external-link" target="_blank"><abbr title="Mozilla Developer Network – Mozilla-Entwickler-Netzwerk">MDN</abbr> Dokumentation über HTTP-Statuscodes</a>. |
| 59 | + |
| 60 | +## Abkürzung, um die Namen zu erinnern |
| 61 | + |
| 62 | +Schauen wir uns das vorherige Beispiel noch einmal an: |
| 63 | + |
| 64 | +```Python hl_lines="6" |
| 65 | +{!../../../docs_src/response_status_code/tutorial001.py!} |
| 66 | +``` |
| 67 | + |
| 68 | +`201` ist der Statuscode für „Created“ („Erzeugt“). |
| 69 | + |
| 70 | +Aber Sie müssen sich nicht daran erinnern, welcher dieser Codes was bedeutet. |
| 71 | + |
| 72 | +Sie können die Hilfsvariablen von `fastapi.status` verwenden. |
| 73 | + |
| 74 | +```Python hl_lines="1 6" |
| 75 | +{!../../../docs_src/response_status_code/tutorial002.py!} |
| 76 | +``` |
| 77 | + |
| 78 | +Diese sind nur eine Annehmlichkeit und enthalten dieselbe Nummer, aber auf diese Weise können Sie die Autovervollständigung Ihres Editors verwenden, um sie zu finden: |
| 79 | + |
| 80 | +<img src="/img/tutorial/response-status-code/image02.png"> |
| 81 | + |
| 82 | +!!! note "Technische Details" |
| 83 | + Sie können auch `from starlette import status` verwenden. |
| 84 | + |
| 85 | + **FastAPI** bietet dieselben `starlette.status`-Codes auch via `fastapi.status` an, als Annehmlichkeit für Sie, den Entwickler. Sie kommen aber direkt von Starlette. |
| 86 | + |
| 87 | +## Den Defaultwert ändern |
| 88 | + |
| 89 | +Später sehen Sie, im [Handbuch für fortgeschrittene Benutzer](../advanced/response-change-status-code.md){.internal-link target=_blank}, wie Sie einen anderen Statuscode zurückgeben können, als den Default, den Sie hier deklarieren. |
0 commit comments