Skip to content

Requisições

Mayara Machado edited this page Aug 7, 2020 · 4 revisions

A API possui 3 segmentação de rotas: a de verificação de atividade da API, as de CRUD de Invoices e as de gerenciamento do Usuário da aplicação. As especificações de cada rota, como parâmetros e status, estão nas próximas páginas.

Possíveis URL para usar nas requisições

Vale lembrar que a API também está disponível em um ambiente Heroku e portanto você pode realizar as seguintes requisições direto usando a url do heroku.

Ambiente URL
Local localhost:3000
Heroku https://mayara-invoices-api.herokuapp.com

Verificação de atividade da API

Método Nome da rota URL
GET Ping [url]/ping

Gerenciamento de Usuário

Método Nome da rota URL
POST Resgistar usuário [url]/user/register
POST Login de usuário [url]/login

Gerenciamento de Invoices

Método Nome da rota URL
POST Criar invoice [url]/invoices
GET Listar invoices [url]/invoices
PUT Alterar Invoice [url]/invoices/<int:id>
DEL Remover logicamente um invoice [url]/invoices/<int:id>