-
Notifications
You must be signed in to change notification settings - Fork 59
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Criar Style Guide da aplicação #82
Comments
Criar uma documentação de styleguide baseado nos styleguides que definimos para o projeto: https://google.github.io/styleguide/go/ Alem disso Documentar como fazer controllers, Models, Usecases, repositories e interfaces. Alem disso documentar tambem como faremos padrao de roteamento: Rotas da API
|
InfraLoggerpath: Funcionalidade:Ferramenta para registrar mensagens durante a execução do programa.
Como usar:Para instanciar o logger em algum lugar da aplicação é necessário usar o package //
package controllers
import (
"pet-dex-backend/v2/infra/config"
... //imports
)
var logger = config.GetLogger("pet-controller")
... // controller
func (pc *PetController) Create(w http.ResponseWriter, r *http.Request){
...
logger.Error(err)
logger.Info("Olha lá")
} O logger tem alguns métodos:
|
Pet ControllerEndpoint para pets 1. Criar Pet:Qual handler?
Payload:{
"name": "Cratos bom de guerra"
} Response:{
"resultado": "sucesso",
"dados": {
"informacao1": "valor1",
"informacao2": "valor2"
}
} 2. Pegar um pet:Qual handler?
Payload:no-body Response:{
"name": "Cratos bom de guerra"
} |
Use CasesCasos de uso para PETS 1. ListUserPetsParamêtros:Fluxo:Repositórios acessados:Retorno: |
EU QUERO!!! |
Describe the feature
Criar Style guide para aplicação, mostrando como deve ser o codigo, como devem ser as rotas, etc.
ESSE É UM DOCUMENTO VIVO
No final, linkar ao readme da aplicação
Description
Precisamos de um template para o style guide. É necessário documentar cada feature a ser inserida na aplicaçãoUse Case
Será usado em todas as features a serem adicionadasImplementation Details
Template paraVisual Concepts
[Include any visual representations or concepts if those are available and applicable.]
Additional Information
Estaremos usando Effective GO, clean arch e DDD:
https://go.dev/doc/effective_go
https://eltonminetto.dev/en/post/2020-07-06-clean-architecture-2years-later/
https://programmingpercy.tech/blog/how-to-domain-driven-design-ddd-golang/
The text was updated successfully, but these errors were encountered: