Skip to content

Commit 0b3d8f0

Browse files
authored
Merge pull request #5 from pangolin-do-golang/feature/swagger
Fix swagger
2 parents 5c58486 + ae183a8 commit 0b3d8f0

File tree

7 files changed

+21
-5
lines changed

7 files changed

+21
-5
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,4 +121,20 @@ curl 'http://localhost:8080/login' -H 'Authorization: Basic dGVzdDp0ZXN0'
121121

122122
## Creating new users
123123

124-
Use the Swagger for access the endpoint `/user` and create a new user.
124+
Use the Swagger for access the endpoint `/user` and create a new user.
125+
126+
## DDD with event storm
127+
128+
The team chose to use [Miro](https://miro.com/) to document this deliverable, available at the [link](https://miro.com/app/board/uXjVLr7Fxbo=/).
129+
130+
The diagram contains:
131+
132+
* System documentation in DDD with Event Storm
133+
* Caption for the ubiquitous language used
134+
* Additional details to understand the proposed resolution
135+
* Worker flow
136+
* API flow
137+
138+
![ubiquitous language](./assets/linguagem%20ubiqua.png)
139+
140+
![event storm](./assets/event%20storm.png)

assets/event storm.png

137 KB
Loading

assets/linguagem ubiqua.png

185 KB
Loading

cmd/http/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import (
1313
"gorm.io/gorm"
1414
)
1515

16-
// @title Thumb processor worker
16+
// @title Thumb Processor API
1717
// @version 0.1.0
1818
// @description Hackathon
1919

docs/docs.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,7 @@ var SwaggerInfo = &swag.Spec{
323323
Host: "localhost:8080",
324324
BasePath: "/",
325325
Schemes: []string{},
326-
Title: "Thumb processor worker",
326+
Title: "Thumb Processor API",
327327
Description: "Hackathon",
328328
InfoInstanceName: "swagger",
329329
SwaggerTemplate: docTemplate,

docs/swagger.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"swagger": "2.0",
33
"info": {
44
"description": "Hackathon",
5-
"title": "Thumb processor worker",
5+
"title": "Thumb Processor API",
66
"contact": {},
77
"version": "0.1.0"
88
},

docs/swagger.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ host: localhost:8080
5252
info:
5353
contact: {}
5454
description: Hackathon
55-
title: Thumb processor worker
55+
title: Thumb Processor API
5656
version: 0.1.0
5757
paths:
5858
/health:

0 commit comments

Comments
 (0)