Giter VIP home page Giter VIP logo

api-nativapps's Introduction

API-NativApps


Esta é uma REST API que foi construída para o sistema web da Nativa Apps. Segue abaixo a sua documentação para utilização desta API.

Ferramentas utilizadas

Instalação

  1. Faça um 'git clone' deste projeto, e execute os comandos abaixo na pasta raíz para instalar as dependencias:

Certifique-se que todas as dependencias foram instaladas, e caso não foram, instale manualmente as dependências que podem não ter sido instaladas pelo comando acima.

  1. Inicie o MongoDB
  • user@user:~/shell$ mongod

O comando acima é para se caso utilize na API um banco de dados MongoDB localmente. Nesta API, já está configurada um banco de dados na nuvem, hospedado na MLab

Para configurar o banco de dados MongoDB, edite o arquivo config/database.js, na linha 2

  1. Inicie a aplicação

A resposta deverá ser semelhante a esta: {"message":"O servidor está online =)"}

Porta do localhost:

Para modificar a porta onde a API será executado no localhost, edite o arquivo config/server.js, na linha 16.

API Routes

Objetos:

aluno | professor | curso

O exemplo abaixo será feito com o objeto 'aluno' mas o mesmo se aplica aos demais objetos citados acima também

Ação Status Metodo URL
Lista todos os itens do objeto 200 GET /api/aluno
Mostra um item com o ID especificado 200 GET /api/aluno/(id)
Cria um novo item 200 POST /api/aluno
Edita o item com o ID especificado 200 PUT /api/aluno/(id)
Deleta o item com o ID especificado 200 DELETE /api/aluno/(id)

Envios por POST

Aluno:

Aluno : {
  nome: 'nome do aluno',
  sobrenome: 'sobrenome do aluno',
  genero: '(M) para Masculoino ou (F) para Feminino',
}

Professor:

Professor : {
  nome: 'nome do aluno',
  sobrenome: 'sobrenome do aluno',
  genero: '(M) para Masculoino ou (F) para Feminino',
}

Curso:

Curso : {
  nome: 'nome do curso',
  obs: 'observação do curso'
}

O ID é gerado automaticamente, pelo MongoDB.

Criado por

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Created By Rodrigo Alves 2018.


api-nativapps's People

Contributors

profalves avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.