lfk/document-server
2
0
Fork 0
Code Issues 2 Pull Requests Actions Projects Releases 13 Wiki Activity

feat(docs): First model for swagger

Browse Source
This commit is contained in:
Nicolai Ort 2024-12-02 17:26:03 +01:00
parent 7d571ad46b
commit 13e9c88a8e
Signed by: niggl
GPG Key ID: 13AFA55AF62F269F
5 changed files with 173 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
docs/docs.go
View File

@ -28,9 +28,67 @@ const docTemplate = `{
"contracts"
],
"summary": "Generate a contract",
"parameters": [
{
"description": "Contract data",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.Contract"
}
}
],
"responses": {}
}
}
},
"definitions": {
"models.Contract": {
"type": "object",
"properties": {
"runners": {
"type": "array",
"items": {
"$ref": "#/definitions/models.Runner"
}
}
}
},
"models.Group": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"parent_group": {
"$ref": "#/definitions/models.Group"
}
}
},
"models.Runner": {
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"group": {
"$ref": "#/definitions/models.Group"
},
"id": {
"type": "integer"
},
"last_name": {
"type": "string"
},
"middle_name": {
"type": "string"
}
}
}
}
}`

58
docs/swagger.json
View File

@ -19,8 +19,66 @@
"contracts"
],
"summary": "Generate a contract",
"parameters": [
{
"description": "Contract data",
"name": "data",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/models.Contract"
}
}
],
"responses": {}
}
}
},
"definitions": {
"models.Contract": {
"type": "object",
"properties": {
"runners": {
"type": "array",
"items": {
"$ref": "#/definitions/models.Runner"
}
}
}
},
"models.Group": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"parent_group": {
"$ref": "#/definitions/models.Group"
}
}
},
"models.Runner": {
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"group": {
"$ref": "#/definitions/models.Group"
},
"id": {
"type": "integer"
},
"last_name": {
"type": "string"
},
"middle_name": {
"type": "string"
}
}
}
}
}

37
docs/swagger.yaml
View File

@ -1,3 +1,33 @@
definitions:
models.Contract:
properties:
runners:
items:
$ref: '#/definitions/models.Runner'
type: array
type: object
models.Group:
properties:
id:
type: integer
name:
type: string
parent_group:
$ref: '#/definitions/models.Group'
type: object
models.Runner:
properties:
first_name:
type: string
group:
$ref: '#/definitions/models.Group'
id:
type: integer
last_name:
type: string
middle_name:
type: string
type: object
info:
contact: {}
description: This is the API documentation for the LfK Document Server - a tool
@ -9,6 +39,13 @@ paths:
consumes:
- application/json
description: Generate a contract based on the provided data
parameters:
- description: Contract data
in: body
name: data
required: true
schema:
$ref: '#/definitions/models.Contract'
produces:
- application/pdf
responses: {}

1
handlers/contract.go
View File

@ -7,6 +7,7 @@ import "github.com/gofiber/fiber/v2"
// @Description Generate a contract based on the provided data
// @Tags contracts
// @Accept json
// @Param data body models.Contract true "Contract data"
// @Produce application/pdf
// @Router /contracts [post]
func GenerateContract(c *fiber.Ctx) error {

19
models/contract.go Normal file
View File

@ -0,0 +1,19 @@
package models
type Contract struct {
Runners []Runner `json:"runners"`
}
type Runner struct {
ID int `json:"id"`
FirstName string `json:"first_name"`
MiddleName string `json:"middle_name"`
LastName string `json:"last_name"`
Group Group `json:"group"`
}
type Group struct {
ID int `json:"id"`
Name string `json:"name"`
ParentGroup *Group `json:"parent_group"`
}