Skip to content

Commit

Permalink
doc(Readme)Added information to the documentation about swagger
Browse files Browse the repository at this point in the history
  • Loading branch information
JonathanProjetos committed Oct 19, 2023
1 parent b1a422b commit 5ed6af0
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,8 @@ npm run test:coverage
### Swagger
- Foi implementada a documentação por parte do Swagger, que possibilita testar a aplicação de forma mais rápida e intuitiva.
- O link para a documentação é [DOC](https://pagarme-production.up.railway.app/docs)
- Alguns end-points séra necessessário oferecer o token para o Authorization no swagger. O token será disponibilizado quando for feito o login é como resposta terá o token.
- Alguns end-points séra necessessário oferecer o token para o Authorization no swagger. O token será disponibilizado quando for feito o login é como resposta terá o token. Caso você não forneça o token para a autorização, os endpoints que dependem dele entrarão em um loop no estado de carregamento (loading).


### Git, GitHub e Histórico de Commits
Este projeto utilizou a [Especificação de Commits Convencionais](https://www.conventionalcommits.org/en/v1.0.0/), com alguns tipos da [convenção Angular](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines). Além disso, foi utilizado o pacote [conventional-commit-cli](https://www.npmjs.com/package/conventional-commit-cli) para ajudar a seguir a convenção de commits. É importante utilizar a convenção de commits em projetos para manter o histórico de commits organizado e facilitar a leitura e o entendimento do que foi desenvolvido.
Expand Down
18 changes: 18 additions & 0 deletions src/doc/swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,24 @@
}
}
}
},
"404":{
"description": "Token not found",
"content":{
"application/json":{
"schema":{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
},
"example": {
"message": "404|Token not found"
}
}
}
}
}
},
Expand Down

0 comments on commit 5ed6af0

Please sign in to comment.