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

120
docs/docs.go Normal file
View File

@@ -0,0 +1,120 @@
// Package docs Code generated by swaggo/swag. DO NOT EDIT
package docs
import "github.com/swaggo/swag"
const docTemplate = `{
"schemes": {{ marshal .Schemes }},
"swagger": "2.0",
"info": {
"description": "{{escape .Description}}",
"title": "{{.Title}}",
"contact": {},
"version": "{{.Version}}"
},
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"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"
}
}
}`
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = &swag.Spec{
Version: "1.0",
Host: "localhost:8080",
BasePath: "/api/v1",
Schemes: []string{},
Title: "GoApi",
Description: "A basic API with support for Swagger and Middleware",
InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate,
LeftDelim: "{{",
RightDelim: "}}",
}
func init() {
swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
}

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"
}
}
}

62
docs/swagger.yaml Normal file
View File

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