====== 1.1 REST Endpunkte ======

Übersicht aller verfügbaren REST((Representational State Transfer: https://de.wikipedia.org/wiki/Representational_State_Transfer))-Endpunkte.

===== Architektur =====

Die API folgt REST-Prinzipien((REST Constraints: https://restfulapi.net/rest-architectural-constraints/)) und verwendet HTTP((Hypertext Transfer Protocol: https://datatracker.ietf.org/doc/html/rfc7231)) Methoden für CRUD-Operationen.

===== Tabellen =====

^ Methode ^ Route ^ Beschreibung ^
| GET | ''/tables'' | Liste aller Tabellen |
| GET | ''/tables/{name}'' | Daten lesen |
| POST | ''/tables/{name}'' | Datensatz einfügen |
| PUT | ''/tables/{name}'' | Datensatz aktualisieren |
| DELETE | ''/tables/{name}'' | Datensatz löschen |
| PATCH | ''/tables/{name}'' | [[.:entwickler:rest:batch|Batch-Änderungen]] |

===== Views =====

^ Methode ^ Route ^ Beschreibung ^
| GET | ''/views'' | Liste aller Views |
| GET | ''/views/{name}'' | View-Daten lesen |

===== Stored Procedures =====

^ Methode ^ Route ^ Beschreibung ^
| GET | ''/procedures'' | Liste aller Prozeduren |
| POST | ''/procedures/{name}/execute'' | Prozedur ausführen |

===== Ad-Hoc Queries =====

^ Methode ^ Route ^ Beschreibung ^
| POST | ''/query'' | SQL-Query ausführen |

===== HTTP Status Codes =====

Die API verwendet Standard HTTP Status Codes((HTTP Status Codes: https://datatracker.ietf.org/doc/html/rfc7231#section-6)):

^ Code ^ Bedeutung ^ Verwendung ^
| 200 | OK | Erfolgreiche GET/PUT/PATCH |
| 201 | Created | Erfolgreicher POST |
| 204 | No Content | Erfolgreicher DELETE |
| 400 | Bad Request | Ungültige Anfrage |
| 401 | Unauthorized | Authentifizierung erforderlich |
| 403 | Forbidden | Keine Berechtigung |
| 404 | Not Found | Ressource nicht gefunden |
| 500 | Server Error | Interner Fehler |

===== Weiterführend =====

  * [[.:entwickler:rest:query-parameter|Query-Parameter]] für Filter und Sortierung
  * [[.:entwickler:rest:crud|CRUD-Operationen]] im Detail
  * [[.:entwickler:rest:batch|Batch-Operationen]] für Massenänderungen

===== Quellen =====

  * [[https://datatracker.ietf.org/doc/html/rfc7231|RFC 7231: HTTP/1.1 Semantics]]
  * [[https://restfulapi.net/|REST API Tutorial]]