项目作者: tupizz

项目描述 :
nodejs api playground
高级语言: JavaScript
项目地址: git://github.com/tupizz/xy-inc-nodejs.git
创建时间: 2019-03-18T22:34:47Z
项目社区:https://github.com/tupizz/xy-inc-nodejs

开源协议:

下载


DOCUMENTAÇÃO DO PROJETO

ESTRUTURA DO BANCO

Foram criados dois bancos no mlab 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:admin123@ds113580.mlab.com:13580/db-xy-poi

Banco de teste: mongodb://admin:admin123@ds123976.mlab.com:23976/db-xy-poi-test

Assim, a seguinte modelagem da entidade foi projetada:

  1. name: String required,
  2. x: Integer required,
  3. y: Integer required,


DESCRIÇÃO DA API

A porta 8888 está exposta, e a partir dela é possível acessar a API de resources:

  • GET

  • 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:

      1. {
      2. "x": 22,
      3. "y": 17,
      4. "name": "Estádio de futebol"
      5. }
  1. - **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
  2. ```json
  3. {
  4. "x": 22,
  5. "y": 17,
  6. "d": 10
  7. }
  8. ```

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

    1. npm install
  2. Entrar na pasta raiz do projeto e executar:

    1. npm start
  3. Caso queira rodar os testes basta executar nessa mesma pasta o seguinte comando:

    1. npm test

    Obs: É necessário ter conexão com a internet para poder realizar a conexão com o banco da aplicação.