Update API Doc
This commit is contained in:
1 parent
5d6d8f15f3
commit
5a56245218
10 files changed
+1196
-229
No files matched your search
@@ -1,3 +1,5 @@
|
||||
// @/app/api/songbooks/[songBookId]/route.ts
|
||||
|
||||
import { NextResponse } from "next/server";
|
||||
import { getSongBookById, updateSongBook, deleteSongBook } from "@/lib/db/songbook";
|
||||
|
||||
@@ -9,38 +11,51 @@ interface RouteParams {
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /api/songbooks/{id}:
|
||||
* /api/songbooks/{songBookId}:
|
||||
* get:
|
||||
* summary: Einzelnen Songbook abrufen
|
||||
* summary: Einzelnes Songbook abrufen
|
||||
* tags:
|
||||
* - Songbooks
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* name: songBookId
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Die ID des Songbooks
|
||||
* example: 1
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Songbook erfolgreich gefunden
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/SongBook'
|
||||
* 400:
|
||||
* description: Ungültige Songbook-ID
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 404:
|
||||
* description: Songbook nicht gefunden
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 500:
|
||||
* description: Serverfehler
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
|
||||
|
||||
export async function GET(_request: Request, { params }: RouteParams) {
|
||||
try {
|
||||
const { songBookId } = await params;
|
||||
|
||||
|
||||
const res = await getSongBookById(parseInt(songBookId));
|
||||
|
||||
|
||||
if (!res.success) {
|
||||
return NextResponse.json({ message: res.error }, { status: res.status });
|
||||
}
|
||||
@@ -58,33 +73,57 @@ export async function GET(_request: Request, { params }: RouteParams) {
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /api/songbooks/{id}:
|
||||
* /api/songbooks/{songBookId}:
|
||||
* patch:
|
||||
* summary: Songbook aktualisieren
|
||||
* tags:
|
||||
* - Songbooks
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* name: songBookId
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Die ID des Songbooks
|
||||
* example: 1
|
||||
* requestBody:
|
||||
* required: true
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* properties:
|
||||
* title:
|
||||
* type: string
|
||||
* example: "Feiert Jesus 1"
|
||||
* language:
|
||||
* type: string
|
||||
* example: "DE"
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Songbook erfolgreich aktualisiert
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/SongBook'
|
||||
* 400:
|
||||
* description: Ungültige Parameter oder Daten
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 404:
|
||||
* description: Songbook nicht gefunden
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 500:
|
||||
* description: Serverfehler
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
export async function PATCH(request: Request, { params }: RouteParams) {
|
||||
try {
|
||||
@@ -100,7 +139,7 @@ export async function PATCH(request: Request, { params }: RouteParams) {
|
||||
} catch (error) {
|
||||
console.error("API Error:", error);
|
||||
return NextResponse.json(
|
||||
{ error: "Fehler beim Laden der Songbookinfos" },
|
||||
{ error: "Fehler beim Aktualisieren des Songbooks" },
|
||||
{ status: 500 }
|
||||
);
|
||||
}
|
||||
@@ -109,27 +148,44 @@ export async function PATCH(request: Request, { params }: RouteParams) {
|
||||
|
||||
/**
|
||||
* @openapi
|
||||
* /api/songbooks/{id}:
|
||||
* /api/songbooks/{songBookId}:
|
||||
* delete:
|
||||
* summary: Songbook löschen
|
||||
* tags:
|
||||
* - Songbooks
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: id
|
||||
* name: songBookId
|
||||
* required: true
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Die ID des Songbooks
|
||||
* example: 1
|
||||
* responses:
|
||||
* 200:
|
||||
* description: Songbook erfolgreich gelöscht
|
||||
* description: Songbook erfolgreich gelöscht (gibt das gelöschte Songbook zurück)
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/SongBook'
|
||||
* 400:
|
||||
* description: Ungültige Songbook-ID
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 404:
|
||||
* description: Songbook nicht gefunden
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
* 500:
|
||||
* description: Serverfehler
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: '#/components/schemas/Error'
|
||||
*/
|
||||
export async function DELETE(_request: Request, { params }: RouteParams) {
|
||||
try {
|
||||
@@ -144,7 +200,7 @@ export async function DELETE(_request: Request, { params }: RouteParams) {
|
||||
} catch (error) {
|
||||
console.error("API Error:", error);
|
||||
return NextResponse.json(
|
||||
{ error: "Fehler beim Laden der Songbookinfos" },
|
||||
{ error: "Fehler beim Löschen des Songbooks" },
|
||||
{ status: 500 }
|
||||
);
|
||||
}
|
||||
|
||||
Reference in new issue
Block a user