API do projeto TaPago - Controle de Gastos Pessoais
- CRUD de Categorias
- CRUD de Movimentações
- CRUD de Usuários
- Dashboard
- Listar Todas as Categorias
- Cadastrar Categoria
- Detalhes da Categoria
- Apagar Categoria
- Atualizar Categoria
GET
/categoria
Retorna um array com todas as categorias cadastradas.
[
{
"id": 1,
"nome": "Alimentação",
"icone": "fast-food"
}
]
código | descrição |
---|---|
200 | Os dados das categorias foram retornados com sucesso |
401 | Acesso negado. Você deve se autenticar |
POST
/categoria
Cria uma nova categoria com os dados enviados no corpo da requisição.
campo | tipo | obrigatório | descrição |
---|---|---|---|
nome | string | ✅ | Um nome curto para a categoria. |
icone | string | ❌ | O nome do ícone de acordo com a biblioteca Material Icons |
{
"nome": "Alimentação",
"icone": "fast-food"
}
{
"id": 1,
"nome": "Alimentação",
"icone": "fast-food"
}
código | descrição |
---|---|
201 | Categoria cadastrada com sucesso |
400 | Dados enviados são inválidos. Verifique o corpo da requisição |
401 | Acesso negado. Você deve se autenticar |
GET
/categoria/{id}
Retornar os detalhes da categoria com o id
informado como parâmetro de path.
// requisição para /categoria/1
{
"id": 1,
"nome": "Alimentação",
"icone": "fast-food"
}
código | descrição |
---|---|
200 | Os dados da categoria foram retornados com sucesso |
401 | Acesso negado. Você deve se autenticar |
404 | Não existe categoria com o id informado |
DELETE
/categoria/{id}
Apaga a categoria com o id
especificado no parâmetro de path.
código | descrição |
---|---|
204 | Categoria foi apagada com sucesso |
401 | Acesso negado. Você deve se autenticar |
404 | Não existe categoria com o id informado |
PUT
/categoria/{id}
Altera dos dados da categoria especificada no id
, utilizando as informações enviadas no corpo da requisição.
campo | tipo | obrigatório | descrição |
---|---|---|---|
nome | string | ✅ | Um nome curto para a categoria. |
icone | string | ✅ | O nome do ícone de acordo com a biblioteca Material Icons |
{
"nome": "Alimentação",
"icone": "fast-food"
}
{
"id": 1,
"nome": "Alimentação",
"icone": "fast-food"
}
código | descrição |
---|---|
200 | Categoria alterada com sucesso |
400 | Dados enviados são inválidos. Verifique o corpo da requisição |
401 | Acesso negado. Você deve se autenticar |
404 | Não existe categoria com o id informado |