diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..90e18f04c72ef04275b54c175c9c6e1809d9f8cf --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# FIT-Connect API-Spezifikation + +Für die Spezifikation der FIT-Connect-Schnittstellen gelten die folgenden Architekturregeln. + +## OpenAPI +- Wir verwenden OpenAPI 3.0 +- Die Spezifikation wird bis zur `beta7` als JSON und ab `beta8` als YAML geschreiben +- Wir verwenden keine Versionsnummern in Dateinamen, da das Repo als Ganzes versioniert wird + +## Verzeichnisse +Das Projektverzeichnis ist wie folgt aufgebaut: + +- ðŸ“`assets` + - ðŸ“`images` - Bilder + - ðŸ“`postman` - Postman-Collection und -Enviroment dazu +- ðŸ“`docs` - Öffentliche Dokumentation zu den APIs +- ðŸ“`models` - Modelle, die von mehreren (beiden) APIs verwendet werden +- ðŸ“`reference` - Die APIs +- 📄`LICENSE` + +## Bezeichner +- Die Bezeichner werden camelCase geschreiben und beginnen mit einem Kleinbuchstaben +- Eine ID (Identifikator) wird als `Id` (nicht `ID`) geschrieben + +## Pfade +Multiple Resoucen werden im Pfad durch eine Collection-Resource und einer nachfolgenden ID aufgenommen + +Beispiel: `/destinations/{destinationId}/applications/{applicationId}`