Api SouthPark - NodeJs + Mongodb

Sobre essa API

API Criada com o intuito acadêmico para consolidar conhecimentos adquiridos durante o curso de programação BackEnd - utilizando as Tecnologias NodeJs, MongoDb, Express

Como usar Esse Projeto

Para utilizar o projeto faça o dowload do arquivo zip, ou faça o clone em seu computador utilizando o Git. Execute o comando npm i dentro da pasta do projeto em seu computador(a pasta que contém o arquivo package.json), para baixar as dependencias do projeto.

Executando o projeto

Essa API utiliza o mongodb(drive nativo), então antes de testar a API certifique se você possui o MongoDb instalado em seu computador(https://www.mongodb.com/try/download/community).

Além disso, você precisa criar o arquivo .env com a url do seu banco, utilize o arquivo .env.exemple para criar o seu. Esse é um exemplo de string de conexão com o banco de dados: mongodb://localhost:27017/db_southpark.

Agora você pode executar o projeto:

• Para executar o projeto com o nodemon, digite no terminal:

npm run dev

• Para executar o projeto com o node, digite no terminal:

npm start

Começando

Vamos fazer nossa primeira solicitação à API South Park!

Para começar a usar a API, use uma ferramenta que permite fazer uma solicitação de API, como curl, Insomnia ou o navegador. No exemplo abaixo, estamos tentando obter as informações:

Solicitação de exemplo:

https://apisouthpark.herokuapp.com/

Resposta de exemplo:

{
    info: "Bem Vindo a API SouthPark Brasil"
}

É isso! Você fez uma chamada Padrão da API

Autenticação

Para Acessar os EndPoints Post e Delete e Necessário um Chave de Autenticação Passada por pela query na Url, Consulte o Administrador para Obter a Chave de Acesso

Procurando

Todas as pesquisas farão correspondências parciais com o (s) campo (s) em que a pesquisa está habilitada. A documentação do recurso individual mostra quais campos podem ser pesquisados por nome ou religião.

Solicitação de exemplo:

https://apisouthpark.herokuapp.com/morador?nome=Cartman

Solicitação de exemplo:

https://apisouthpark.herokuapp.com/morador?religiao=católico

Moradores De SouthPark

Representa um personagem do Universo South Park.

Endpoints:

• /moradores - obtenha todos os recursos do personagem
• /morador/{id} - obter um recurso de personagem específico

Solicitação de exemplo:

https://apisouthpark.herokuapp.com/morador/613f285fb7b1bc45b5527e2b

Resposta de exemplo:

{
    _id: "613f285fb7b1bc45b5527e2b",
    nome: "Stan Marsh",
    idade: 10,
    genero: "Masculino",
    ocupacao: "Estudante",
    cor_cabelo: "Preto",
    religiao: "católico",
    imgUrl: "https://static.wikia.nocookie.net/southpark/images/c/c6/Stan-marsh-0.png/revision/latest/scale-to-width-down/319?cb=20210107202918"
}

Atributos:

• id - O id deste personagem
• nome - O nome pelo qual esse personagem é conhecido
• idade - A idade desse personagem em anos
• genero - O Genero do personagem
• ocupacao - A ocupação deste personagem
• cor_cabelo - A cor do cabelo deste personagem
• religiao - A religião principal deste personagem (mudanças temporárias de religião não rastreadas)
• imgUrl - Imagem do Personagem

Episódios

Um episódio da série South Park.

Endpoints:

• /episodios - obtenha todos os recursos do episódio

• /episodios/:id - obtenha um ep especifico

Solicitação de exemplo:

https://apisouthpark.herokuapp.com/episodios

Resposta de exemplo:

[
    {
        _id: "613dcd83d451d4370d064391",
        nome: "Cartman ganha uma sonda anal",
        temporada: 1,
        episodeo: "1",
        lancamento: "13/08/1997"
    },
    {
        _id: "613e4ea06eccb61dd0d2846e",
        nome: "Vulcão",
        temporada: "1",
        episodeo: "2",
        lancamento: "20/08/1997"
}
]

Desenvolvido Por - Hyago Bezerra

Muito Obrigado!