zardzul/music-index
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Implement swagger

Browse Source
This commit is contained in:
zardzul
2026-03-13 21:03:01 +01:00
parent 30298390a0
commit 0deee355c1
10 changed files with 652 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api/docs/swagger.json
+175
View File
@@ -0,0 +1,175 @@
{
"swagger": "2.0",
"info": {
"description": "API for managing users and artists in Music Index.",
"title": "Music Index API",
"contact": {},
"version": "1.0"
},
"basePath": "/",
"paths": {
"/artist/getAll": {
"get": {
"produces": [
"application/json"
],
"tags": [
"artist"
],
"summary": "List all artists",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/handlers.ErrorResponse"
}
}
}
}
},
"/user/create": {
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Create a user",
"parameters": [
{
"description": "User payload",
"name": "payload",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/handlers.CreateUserRequest"
}
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/handlers.CreateUserResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/handlers.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/handlers.ErrorResponse"
}
}
}
}
},
"/user/getUserNameByID/{id}": {
"get": {
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Get username by user ID",
"parameters": [
{
"type": "string",
"description": "User ID (UUID)",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/handlers.UsernameResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/handlers.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/handlers.ErrorResponse"
}
}
}
}
}
},
"definitions": {
"handlers.CreateUserRequest": {
"type": "object",
"required": [
"password",
"user_mail",
"user_name"
],
"properties": {
"password": {
"type": "string",
"minLength": 12
},
"user_mail": {
"type": "string"
},
"user_name": {
"type": "string"
}
}
},
"handlers.CreateUserResponse": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"handlers.ErrorResponse": {
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
},
"handlers.UsernameResponse": {
"type": "object",
"properties": {
"user_name": {
"type": "string"
}
}
}
}
}