Este é um modelo base de API RESTful usando framework ExpressJS e com ArangoJS (driver do ArangoDB). O propósito deste projeto é apenas ter uma aplicação inicial para qualquer projeto. Os arquivos de rotas presentes no projeto não tem nenhum propósito específico, então, pode ser desconsiderada ao criar uma nova aplicação. Este projeto foi gerado com o Gerador ExpressJS versão 4.15.2.
Este modelo já possui algumas ferramentas que proporcionam o início rápido de um novo projeto. Antes de tudo, certifique-se que você tem a o ArangoDB instalado em sua máquina.
Abra o arquivo database.js e edite as linhas 4, 5, 6, e 7 com endereço do banco de dados com a porta de acesso, usuário do banco de dados, senha do usuário do banco de dados e com o nome do banco de dados. Certifique-se de que o banco de dados tenha sido criado e que o usuário tenha permissão sob este banco de dados. Qualquer dúvida consulte o Manual do ArangoDB.
Abra o arquivo collections-config.js e insira as coleções de dados utilizadas. Deve-se utilizar o mesmo padrão definido no modelo inicial:
const collectionConfig = [
{ name: "minhaColecao", type: 1 },
{ name: "outraColecao", type: 2 }
];
O parâmetro name deve conter o nome da coleção. É recomendado que este nome siga a Convenção disponibilizada na documentação do ArangoDB. O parâmetro type deve conter um inteiro indicando o tipo de coleção. O valor 1 indica coleção de documentos e o valor 2 indica coleção de arestas.
Abra o terminal, navegue até o diretório do projeto e execute npm install. Os pacotes necessários serão instalados pelo npm. Este processo pode levar um tempo.
Execute npm start para iniciar o serviço. Acesse http://localhost:3000/v1/users para ver a lista de usuários cadastrados. A aplicação vai recarregar automaticamente se você alterar qualquer arquivo do projeto porque o Nodemon está configurado no arquivo package.json.
Entre em contato comigo caso encontre algum erro, bug ou deseja sugerir melhoria.
Michael Charles Email: michaelcharlesfs@gmail.com