Este projeto consiste em construir uma API para o jogo Bravely Default, desenvolvida por mim e que será consumida no projeto da Montagem de uma Wiki do jogo, podendo ter o progresso conferido neste link.
A primeira versão feita para este projeto de API foi construída utilizando o site mockapi.io, este site permite que o usuário crie e consuma uma API limitada no plano gratuito e já está finalizada, podendo ser conferida a partir da clonagem do projeto(necessário uma conta criada no site para clonar).
A versão completa está sendo construída neste exato momento e seu progresso poderá ser conferido no presente repositório.
Consistindo de uma aplicação feita em Node.js, o objetivo é fazer uma API completa do jogo que possa ser futuramente ser integrada e consumida dentro do projeto de Wiki do jogo
- Criar o servidor que irá rodar a aplicação
- Determinar quais arquivos em .json estarão incluídos na API
- Criar as rotas que irão consumir os arquivos .json e retornar os dados
- Criar o arquivo principal da aplicação que irá mapear qual URL irá utilizar um determinado arquivo
- Adicionar mais dados aos arquivos .json
- Criar Rotas para os Locais do jogo
- Integrar a API no projeto principal ou descobrir uma forma fazer upload dela em uma URL permanente
- Consumir a API na Wiki do jogo
Para a versão Beta da API, foi utilizado apenas o site mockapi.io como recurso utilizado, além da montagem dos arquivos .json para serem consumidos no site, baseados na Wiki oficial do jogo
Já na versão Completa, estou utilizando das seguintes bibliotecas em Node.JS para criar a aplicação:
- Express para ser possível criar um servidor que recebe requisições e retorna os dados solicitados
- CreateRequire para importar arquivos .json sem que haja conflitos devido a sintaxe nova do JavaScript ES6
- Pesquisei um site para fazer Mocks de APIs e construí um modelo de API que está sendo consumido pela Wiki do Jogo
- Alimentei esta API limitada com arquivos .json e configurei meu projeto principal para fazer requisições
- Estudei como criar uma API usando Node.JS
- Implementei um servidor que fica "ouvindo" requisições no arquivo server.js
- Criei os arquivos que retornarão os dados dos .json para a aplicação na pasta "routes"
- Fiz o mapeamento de quais rotas poderiam ser acessadas para se ter uma requisição no arquivo App.js
Para instalar as dependências do projeto localmente, utilize a instrução abaixo:
- Após baixar o projeto, digite no terminal
yarn installe espere pela instalação das dependências, após isso, siga para a etapa de Execução
Para executar o programa é necessário instalar as dependências utilizadas, que estão no package.json e após isso executar o projeto,para estar operações, utilize os comandos abaixo:
- Digite no terminal
yarn startpara rodar o projeto em modo desenvolvimento.
- Vítor Ribeiro (MrVtR)