Initial commit
This commit is contained in:
@@ -0,0 +1,14 @@
|
||||
# OpenAPI Spec
|
||||
|
||||
Do tohto adresara patria OpenAPI specifikacie alebo generator configy pre backend kontrakty.
|
||||
|
||||
Odporucany workflow:
|
||||
|
||||
1. uloz OpenAPI subor alebo odkaz na repo so specifikaciou
|
||||
2. priprav `openapi-ts.config.ts`
|
||||
3. spusti `pnpm generate:api`
|
||||
4. v `api/wrappers` vytvor tenku vrstvu nad vygenerovanym klientom
|
||||
|
||||
Aktualny codegen pouziva `@hey-api/openapi-ts`, takze v dev containery nie je potrebna Java.
|
||||
|
||||
Komponenty a pages by nemali volat generovany klient priamo. Preferuj composables alebo wrappery, aby sa dalo API jednoducho menit bez zasahu do UI.
|
||||
@@ -0,0 +1,39 @@
|
||||
openapi: 3.0.3
|
||||
info:
|
||||
title: Example API
|
||||
version: 1.0.0
|
||||
servers:
|
||||
- url: /api
|
||||
paths:
|
||||
/health:
|
||||
get:
|
||||
operationId: getHealth
|
||||
responses:
|
||||
'200':
|
||||
description: API health status
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- status
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
enum:
|
||||
- ok
|
||||
/welcome:
|
||||
get:
|
||||
operationId: getWelcome
|
||||
responses:
|
||||
'200':
|
||||
description: Welcome message
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- message
|
||||
properties:
|
||||
message:
|
||||
type: string
|
||||
Reference in New Issue
Block a user