Model 1 - generering af swagger/openapi dokumentation af eksisterende API'er

Description

3.part der ønsker at anvende de eksisterende API’er på OS2autoproces, skal i dag anvende den dokumentation der findes her

https://www.os2autoproces.eu/doc

til at udvikle deres integration op mod OS2autoproces.

Det ønskes at der også udarbejdes en swagger/openapi dokumentationsfil til de eksisterende API’er, som kan anvendes af værktøjer der kan indlæse en sådan dokumentation. Hermed kan en udvikler, som anvender et kompatibelt værktøj, indlæse filen og få dannet en “kodeskal” til at anvende API’et. En udvikler skal dog stadig kode alt sin forretningslogik, det er alene en skal til at kalde API’et der generes.

Løsningsbeskrivelse

OS2autoproces udstiller i dag 2 slags API’er. Genererede API’er via Spring Data REST, og kodede API’er. Begge disse udstilles, og der anvendes Spring REST Docs til at auto-generere swagger/openapi dokumentationen baseret på koden.

Dokumentationen udstilles som et endpoint på OS2autoproces, så den altid er tilgængelig, og afspejler de faktiske API’er der er deployet.

Ved fremtidige kodeændringer til API’et, vil swagger/openapi dokumentationen automatisk blive opdateret.

Pris

8.000 DKK

Acceptance criteria

None

How to test

None

Activity

Show:
Fixed

Details

Assignee

Reporter

Priority

Created 30 June 2024 at 06:40
Updated 8 January 2025 at 12:18
Resolved 29 November 2024 at 07:06