mocode-software/meldestelle
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

(fix) Umbau zu SCS

Browse Source 
### 1.1 OpenAPI-Dokumentation implementieren
- Swagger/OpenAPI in bestehenden Ktor-Diensten integrieren
- Zentrale API-Dokumentationsseite im API-Gateway erstellen
- CI/CD-Pipeline um automatische API-Dokumentationsgenerierung erweitern
- Entwickler-Guidelines für API-Dokumentation erstellen
This commit is contained in:
stefan
2025-07-21 13:48:36 +02:00
parent 81e40e70fc
commit 143de2b4d5
2 changed files with 127 additions and 130 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api-gateway/src/jvmMain/kotlin/at/mocode/gateway/routing/DocRoutes.kt
-3
View File
@@ -1,12 +1,9 @@
package at.mocode.gateway.routing package at.mocode.gateway.routing
import at.mocode.dto.base.ApiResponse import at.mocode.dto.base.ApiResponse
import io.ktor.http.*
import io.ktor.server.application.*
import io.ktor.server.response.* import io.ktor.server.response.*
import io.ktor.server.routing.* import io.ktor.server.routing.*
import kotlinx.serialization.Serializable import kotlinx.serialization.Serializable
import java.io.File
/** /**
* Sets up routes for API documentation * Sets up routes for API documentation
docs/API_DOCUMENTATION_EXAMPLE.md
+4 -4
View File
@@ -84,7 +84,7 @@ Following our API documentation guidelines, we would add the following to the Op
type: integer type: integer
format: int32 format: int32
minimum: 0 minimum: 0
example: 3 example: "3"
- name: maxAge - name: maxAge
in: query in: query
description: Maximum age in years description: Maximum age in years
@@ -93,14 +93,14 @@ Following our API documentation guidelines, we would add the following to the Op
type: integer type: integer
format: int32 format: int32
minimum: 0 minimum: 0
example: 15 example: "15"
- name: gender - name: gender
in: query in: query
description: Horse gender description: Horse gender
required: false required: false
schema: schema:
type: string type: string
enum: [STALLION, MARE, GELDING] enum: [ STALLION, MARE, GELDING ]
example: "MARE" example: "MARE"
- name: ownerName - name: ownerName
in: query in: query
@@ -110,7 +110,7 @@ Following our API documentation guidelines, we would add the following to the Op
type: string type: string
example: "Schmidt" example: "Schmidt"
security: security:
- bearerAuth: [] - bearerAuth: [ ]
responses: responses:
'200': '200':
description: Successful operation description: Successful operation