README.md

# 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: `/applications/{applicationId}`

## API-Version taggen

    git tag -a v1.0.4 -m "API Version 1.0.4"