(fix) Umbau zu SCS
### 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:
@@ -1,12 +1,9 @@
|
||||
package at.mocode.gateway.routing
|
||||
|
||||
import at.mocode.dto.base.ApiResponse
|
||||
import io.ktor.http.*
|
||||
import io.ktor.server.application.*
|
||||
import io.ktor.server.response.*
|
||||
import io.ktor.server.routing.*
|
||||
import kotlinx.serialization.Serializable
|
||||
import java.io.File
|
||||
|
||||
/**
|
||||
* Sets up routes for API documentation
|
||||
|
||||
@@ -84,7 +84,7 @@ Following our API documentation guidelines, we would add the following to the Op
|
||||
type: integer
|
||||
format: int32
|
||||
minimum: 0
|
||||
example: 3
|
||||
example: "3"
|
||||
- name: maxAge
|
||||
in: query
|
||||
description: Maximum age in years
|
||||
@@ -93,14 +93,14 @@ Following our API documentation guidelines, we would add the following to the Op
|
||||
type: integer
|
||||
format: int32
|
||||
minimum: 0
|
||||
example: 15
|
||||
example: "15"
|
||||
- name: gender
|
||||
in: query
|
||||
description: Horse gender
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
enum: [STALLION, MARE, GELDING]
|
||||
enum: [ STALLION, MARE, GELDING ]
|
||||
example: "MARE"
|
||||
- name: ownerName
|
||||
in: query
|
||||
@@ -110,7 +110,7 @@ Following our API documentation guidelines, we would add the following to the Op
|
||||
type: string
|
||||
example: "Schmidt"
|
||||
security:
|
||||
- bearerAuth: []
|
||||
- bearerAuth: [ ]
|
||||
responses:
|
||||
'200':
|
||||
description: Successful operation
|
||||
|
||||
Reference in New Issue
Block a user