Giter Club home page Giter Club logo

backend-teste's Introduction

API mulheres da tecnologia

GitHub repo size Linkedin URL

Table of Contents

  1. Sobre
  2. Tecnologias
  3. Endpoints
  4. Responses
  5. Rodando localmente
  6. Como contribuir para o projeto
  7. Licença

💻 Sobre o projeto

Uma API desenvolvida no curso de backend - minha primeira API da Programaria.

  • Lista mulheres no banco de dados
  • Cria uma nova mulher no banco de dados
  • Atualiza informações de cada mulher
  • Deleta mulher

🛠 Tecnologias

  • Express
  • MongoDB
  • Mongoose

📍 Endpoints

URL base: https://backend-teste-vn7a.onrender.com

Método Endpoint Descrição
GET /mulheres Retorna um array de objetos com as informações das mulheres.
POST /nova-mulher Adiciona uma nova mulher passando o objeto no body da requisição
PATCH /mulheres/$id Atualiza dados de uma mulher pelo seu id.
DELETE /mulheres/$id Remove uma mulher do banco de dados pelo id.

✅ Responses

GET /mulheres

[
  {
    "_id": "6674a0657574e7a7a5cacd02",
    "name": "Ada Lovelace",
    "image": "https://s2-techtudo.glbimg.com/7YOBBhghbMF9wsUuBP7UcUh2yXI=/0x342:2439x2307/1008x0/smart/filters:strip_icc()/i.s3.glbimg.com/v1/AUTH_08fbf48bc0524877943fe86e43087e7a/internal_photos/bs/2021/n/3/FbrmyhQneVYWGUPIe8vA/adalovelace.jpg",
    "desc": "Augusta Ada Byron King, Condessa de Lovelace, atualmente conhecida como Ada Lovelace, foi uma matemática e escritora inglesa. Hoje é reconhecida principalmente por ter escrito o primeiro algoritmo para ser processado por uma máquina, a máquina analítica de Charles Babbage.",
    "__v": 0
  },
]

POST /nova-mulher

Retorna o objeto da nova mulher adicionada

  {
    "_id": "6674a06f7574e7a7a5cacd06",
    "name": "Grace Hopper",
    "image": "https://www.alura.com.br/artigos/assets/mulheres-historia-tecnologia-programacao/grace-hopper.jpg",
    "desc": "Grace Hopper foi uma das primeiras a se tornar PhD em Matemática, ela trabalhou na Marinha dos Estados Unidos durante a Segunda Guerra Mundial, sendo uma das responsáveis por programar o Mark I, o primeiro computador eletromecânico do mundo. Criadora da linguagem de programação de alto nível Flow-Matic (em desuso), base para a criação do COBOL. Uma curiosidade sobre Grace Hopper é que foi por causa dela que começamos a chamar as falhas de “bug”. Isso porque Grace, ao tentar encontrar a origem de um problema em seu computador, descobriu um inseto morto dentro da máquina.",
    "__v": 0
  }

PATCH /mulheres/$id

Retorna o objeto da mulher com as informações corrigidas

  {
    "_id": "6674a0657574e7a7a5cacd02",
    "name": "Ada Lovelace",
    "image": "https://s2-techtudo.glbimg.com/7YOBBhghbMF9wsUuBP7UcUh2yXI=/0x342:2439x2307/1008x0/smart/filters:strip_icc()/i.s3.glbimg.com/v1/AUTH_08fbf48bc0524877943fe86e43087e7a/internal_photos/bs/2021/n/3/FbrmyhQneVYWGUPIe8vA/adalovelace.jpg",
    "desc": "Ada Lovelace foi uma matemática e escritora inglesa. Hoje é reconhecida principalmente por ter escrito o primeiro algoritmo para ser processado por uma máquina, a máquina analítica de Charles Babbage.",
    "__v": 0
  }

DELETE /mulheres/$id

  {
    "message": "Mulher deletada com sucesso"
  }

🚀 Rodando localmente

Clone o projeto

  git clone https://github.com/aliine98/backend-teste

Entre no diretório do projeto

  cd backend-teste

Instale as depêndencias

  npm install

Rode o servidor

  node index.js

😯 Como contribuir para o projeto

  1. Faça um fork do projeto.
  2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
  3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m ":sparkles: feat: My new feature"
  4. Envie as suas alterações: git push origin my-feature
  5. No seu repositório clique num botão chamado Compare & Pull Request e crie o seu PR.

Caso tenha alguma dúvida confira este guia de como contribuir no GitHub

📝 Licença

License

Feito com ❤️ por Aline Bevilacqua!

⬆ Voltar ao topo

backend-teste's People

Contributors

aliine98 avatar

Watchers

 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.