diff --git a/backend/cmd/api/docs/docs.go b/backend/cmd/api/docs/docs.go new file mode 100644 index 0000000..0fe2d2e --- /dev/null +++ b/backend/cmd/api/docs/docs.go @@ -0,0 +1,62 @@ +// 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": { + "/": { + "get": { + "description": "Get a hello message", + "produces": [ + "text/plain" + ], + "summary": "Say hello", + "operationId": "hello", + "responses": { + "200": { + "description": "Hello from the Time Tracker Backend!", + "schema": { + "type": "string" + } + } + } + } + } + }, + "securityDefinitions": { + "BearerAuth": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + } +}` + +// SwaggerInfo holds exported Swagger Info so clients can modify it +var SwaggerInfo = &swag.Spec{ + Version: "1.0", + Host: "localhost:8080", + BasePath: "/api", + Schemes: []string{}, + Title: "Time Tracker API", + Description: "This is a simple time tracker API.", + InfoInstanceName: "swagger", + SwaggerTemplate: docTemplate, + LeftDelim: "{{", + RightDelim: "}}", +} + +func init() { + swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo) +} diff --git a/backend/cmd/api/docs/swagger.json b/backend/cmd/api/docs/swagger.json new file mode 100644 index 0000000..0de2968 --- /dev/null +++ b/backend/cmd/api/docs/swagger.json @@ -0,0 +1,38 @@ +{ + "swagger": "2.0", + "info": { + "description": "This is a simple time tracker API.", + "title": "Time Tracker API", + "contact": {}, + "version": "1.0" + }, + "host": "localhost:8080", + "basePath": "/api", + "paths": { + "/": { + "get": { + "description": "Get a hello message", + "produces": [ + "text/plain" + ], + "summary": "Say hello", + "operationId": "hello", + "responses": { + "200": { + "description": "Hello from the Time Tracker Backend!", + "schema": { + "type": "string" + } + } + } + } + } + }, + "securityDefinitions": { + "BearerAuth": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + } +} \ No newline at end of file diff --git a/backend/cmd/api/docs/swagger.yaml b/backend/cmd/api/docs/swagger.yaml new file mode 100644 index 0000000..dbc3dc9 --- /dev/null +++ b/backend/cmd/api/docs/swagger.yaml @@ -0,0 +1,26 @@ +basePath: /api +host: localhost:8080 +info: + contact: {} + description: This is a simple time tracker API. + title: Time Tracker API + version: "1.0" +paths: + /: + get: + description: Get a hello message + operationId: hello + produces: + - text/plain + responses: + "200": + description: Hello from the Time Tracker Backend! + schema: + type: string + summary: Say hello +securityDefinitions: + BearerAuth: + in: header + name: Authorization + type: apiKey +swagger: "2.0" diff --git a/backend/cmd/api/main.go b/backend/cmd/api/main.go index 8f8af84..1219291 100644 --- a/backend/cmd/api/main.go +++ b/backend/cmd/api/main.go @@ -24,8 +24,6 @@ import ( // @in header // @name Authorization -// @x-extension ulid.ULID string - // @Summary Say hello // @Description Get a hello message // @ID hello