https://github.com/tupizz/xy-inc-nodejs
nodejs api playground
https://github.com/tupizz/xy-inc-nodejs
api express express-validator mongodb mongoose nodejs
Last synced: 2 months ago
JSON representation
nodejs api playground
- Host: GitHub
- URL: https://github.com/tupizz/xy-inc-nodejs
- Owner: tupizz
- Created: 2019-03-18T22:34:47.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-18T22:35:47.000Z (about 6 years ago)
- Last Synced: 2025-02-09T14:47:16.444Z (4 months ago)
- Topics: api, express, express-validator, mongodb, mongoose, nodejs
- Language: JavaScript
- Homepage:
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
DOCUMENTAÇÃO DO PROJETO
===========================================
## **ESTRUTURA DO BANCO**
Foram criados dois bancos no [mlab](https://mlab.com) sendo um para a aplicação e outro para rodar os testes de integração, com as seguintes URIs de conexão:
**Banco principal:** `mongodb://admin:[email protected]:13580/db-xy-poi`
**Banco de teste:** `mongodb://admin:[email protected]:23976/db-xy-poi-test`
Assim, a seguinte modelagem da entidade foi projetada:
name: String required,
x: Integer required,
y: Integer required,
## **DESCRIÇÃO DA API**
A porta 8888 está exposta, e a partir dela é possível acessar a API de resources:
- **GET**
- **Listagem:** Para consultar todos os recursos cadastrados no banco, basta acessar http://localhost:8888/poi
- **POST**
- **Criação de novo POI:** A partir de http://localhost:8888/poi é possível criar um novo POI, como payload debe ser enviado um objeto JSON, como no exemplo:
```json
{
"x": 22,
"y": 17,
"name": "Estádio de futebol"
}
```
- **Encontrar POI's proximos:** A partir de http://localhost:8888/poi/near é possível listar todos os pois proximos a um determinado ponto levando em consideração uma thresold de distância
```json
{
"x": 22,
"y": 17,
"d": 10
}
```
## **EXECUTANDO O PROJETO**
Foi criado no **package.json** dois scripts para iniciar a aplicação e rodar os testes de integração, mas antes de executar qualquer um desses dois scripts é necessário seguir os seguintes passos:
1. Baixar as dependencias da aplicação
npm install
1. Entrar na pasta raiz do projeto e executar:
npm start
1. Caso queira rodar os testes basta executar nessa mesma pasta o seguinte comando:
npm test
**Obs:** É necessário ter conexão com a internet para poder realizar a conexão com o banco da aplicação.
----------