https://github.com/dleitee/todo-api
https://github.com/dleitee/todo-api
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/dleitee/todo-api
- Owner: dleitee
- License: mit
- Created: 2015-02-17T17:49:53.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2018-06-05T16:28:12.000Z (about 8 years ago)
- Last Synced: 2025-02-18T19:16:06.746Z (over 1 year ago)
- Language: JavaScript
- Size: 7.81 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# todo-api
Exemplo de api restful utilizando modelo de autenticação básica.
## Executar em localhost
Tenha instalado o [Node.js](http://nodejs.org/) e o [MongoDB](https://www.mongodb.org)
Inicie o serviço de banco de dados:
```sh
$ mongod
```
Execute a aplicação:
```sh
$ git clone https://github.com/dleitee/todo-api.git
$ cd todo-api
$ npm install
$ npm start
```
Node app is running at localhost: [localhost:5000](http://localhost:5000/).
## API
Utilize a ferramenta [Postman](http://www.getpostman.com/) para executar os testes.
***
###[/users](http://localhost:5000/api/users)
#####POST - Cadastra um novo usuário com os parâmetros
- username
- password
#####GET - Retorna todos os usuários habilitados (*)
_(*) Necessita autenticação_
***
###[/todos](http://localhost:5000/api/todos)
#####POST - Cadastra uma nova tarefa com os parâmetros (*)
- task
#####GET - Retorna todas as tarefas cadastradas (*)
_(*) Necessita autenticação_
***
###[/todos/:todo_id](http://localhost:5000/api/todos/:todo_id)
#####GET - Retorna a tarefa indicada em :todo_id (*)
#####PUT - Edita a tarefa indicada em :todo_id com o parâmetro: (*)
- task
#####DELETE - Deleta a tarefa indicada em :todo_id (*)
_(*) Necessita autenticação_
***
###License
MIT