Spezifikation URL-artige URIs
Warum?
Als Entwickler möchte ich eine klare Vorgabe, wie URIs zu bilden sind. Viele die URIs (eindeutige IDs) in FIT-Connect werden so gebildet, dass sie auch einer URL (Internetadresse) entsprechen. Das Schema zum bilden von neuen URIs muss für alle Entwickelnden dokumentiert werden.
Relevante Links und Bemerkungen
Beispiele für URIs:
https://schema.fitko.de/fit-connect/submission-api/problems/constraint-violation
https://schema.fitko.de/fit-connect/oauth/scopes/dvdv-fit-connect-api/manage-destinations
https://schema.fitko.de/fit-connect/events/create-submission
https://schema.fitko.de/fit-connect/events/problems/invalid-event-log
RegEx für Problem-URIs in Events: ^https:\\/\\/schema\\.fitko\\.de\\/fit-connect\\/events\\/problems\\/[-a-z]+$
Idee
Aufbau aller URIs nach diesem Schema:
https://schema.fitko.de/fit-connect/{Artefakt}/{Typ}/{Name}
https://schema.fitko.de/fit-connect/{Artefakt}/{Typ}/{Gruppe}/{Name}
Mit diesen Teilen:
-
https://schema.fitko.de/fit-connect
: FIT-Connect Basis-URI - Artefakt:
- submission-api
- oauth
- events (z.B. Probleme bei Events)
- ...
- Typ:
- problems
- scopes
- events (Die Events)
- ...
- Gruppe: Möglichst vermeiden
- Bei älteren Scopes steht hier der Name der API. Das wird bei neueren Scopes nicht mehr gemacht.
- ...
- Name: Spezifische Bezeichnung in Kleinbuchstaben mit Bindestrich
- attachments-mismatch
- method-not-supported
- manage-destinations
- ...
Akzeptanzkriterien
-
... -
... -
...
Durchführungsplan (von Entwickler:in bei Umsetzungsplanung auszufüllen)
-
... -
... -
... -
Definition of Done wurde geprüft
Edited by Andreas Huber