Projeto API XY-Inc
XY-Inc é um servidor de API Rest implementado em Node.js e Express.js com Mongoose.js para a integração com o banco de dados MongoDB. O projeto gerencia POIs (Pontos de Interesse) disponibilizando os seguintes serviços.
- Cadastro de pontos de interesse: POST (/api/coordinate)
- Listagem de todos os POIs cadastrados: GET (/api/coordinate)
- Listagem POIs por proximidade: GET (/api/getnear)
É necessário ter o Node.js e MongoDB instalados. Certificado destes requisitos, navegue até a pasta do projeto e execute o comando abaixo.
npm installnode serverPor favor, veja detalhes em [MongoDB](https://www.mongodb.com) para executar o serviço conforme o seus sistema operacional.Utlizando qualquer cliente HTTP é possível acessar os serviços do projeto pelas seguintes URLs.
- Cadastro de pontos de interesse: Executando um POST em http://localhost:3000/api/coordinate passando no body da requisição um objeto Coordinate (veja o arquivo models/insert_objects.json).
- Listagem de todos os POIs cadastrados: GET http://localhost:3000/api/coordinate
- Listagem dos POIs por proximidade: GET http://localhost:3000/api/getnear?lng=&lat=&dmax=? onde os parâmetros são inteiros representando respectivamente a longitude, latitude e distância máxima para busca.
Para executar os testes automatizados, é necessário instalar o MochaJS.
mochaAbaixo são listados alguns dos módulos não padronizados utilizados no projeto:
Criado e mantido por Raphael de Souza Pimenta ([@raphaelspimenta]).
NodeAPI está disponível sobre a licença do MIT. Veja o arquivo LICENSE.md para mais informações.