atridad/goapi
Template
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial commit

Browse Source
This commit is contained in:
Atridad Lahiji
2025-10-08 16:49:13 +00:00
commit 7274adfa0d
12 changed files with 624 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

96
docs/swagger.json Normal file
View File

@@ -0,0 +1,96 @@
{
"swagger": "2.0",
"info": {
"description": "A basic API with support for Swagger and Middleware",
"title": "GoApi",
"contact": {},
"version": "1.0"
},
"host": "localhost:8080",
"basePath": "/api/v1",
"paths": {
"/health": {
"get": {
"description": "Check if the API is running",
"produces": [
"application/json"
],
"tags": [
"health"
],
"summary": "Health check",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
}
}
},
"/users": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Get list of all users",
"produces": [
"application/json"
],
"tags": [
"users"
],
"summary": "Get users",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/main.User"
}
}
},
"401": {
"description": "Unauthorized",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
}
}
}
},
"definitions": {
"main.User": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
}
},
"securityDefinitions": {
"ApiKeyAuth": {
"type": "apiKey",
"name": "X-API-Key",
"in": "header"
}
}
}