joaoplay16/brazil-universities-api

Uma API que lista as universidades do Brasil com informações sobre nome, domínios e páginas web.

API de Universidades do Brasil

Sumário

1. Sobre o projeto
   • Exemplos
2. Dependências
3. Instalação e execução
   • Opção 1
   • Opção 2
4. Testes de api
5. Licença
6. Contato

Sobre o projeto

Fornece um endpoint para pesquisa de universidades do Brasil.

Uma API que lista as universidades do Brasil com informações sobre nome, domínios e páginas web. Demo hospedada em container Docker na Heroku

Exemplos de pesquisa na API hospedada

https://brazil-universities-api.herokuapp.com/search
 https://brazil-universities-api.herokuapp.com/search?universityName=Estacio
https://brazil-universities-api.herokuapp.com/search?universityName=Universidade&stateProvince=Maranhao 

Endpoints de pesquisa:

/search
/search?universityName=Universidade
/search?universityName=Universidade&stateProvince=Maranhao

Mais informações acesse a documentação da API feita com Swagger acessando o endpoint abaixo:

/api-docs

Dependências

• NodeJS
• Docker
• Docker Compose

Instalação e execução

Opção 1 Rodando o container Docker localmente

1. Baixe e instale o Docker e o Docker Compose
2. Clone este repositório para sua máquina
3. Renomeie o arquivo .env.docker.example para .env
4. Rode o comando abaixo para iniciar todos os containers. Esse comando irá baixar as imagens e executar os containers.

docker-compose up

6. Abra no navegador a URL abaixo para verificar se a API está em execução corretamente.

http://localhost:8088/

Se tudo estiver OK, você receberá uma resposta para a requisição semelhante a esta:

{
	"author":{
		"name":"João Pedro de Freitas Brito",
		"website":"https://github.com/joaoplay16"
	},
	"github":"https://github.com/joaoplay16/brazil-university-api",
	"example":"https://brazil-universities-api.herokuapp.com/search"
}

Opção 2 Rodando a API localmente com Node

1. Clone este repositório para sua máquina
2. Renomeie o arquivo .env.example para .env e adicione a URI do banco de dados MongoDB.

MONGODB_URI=<YOUR_MONGODB_URI>

3. Execute o comando yarn install para instalar as dependências.
4. Execute o comando yarn dev para iniciar o servidor em modo de desenvolvimento.
5. Abra no navegador a URL abaixo para verificar se a API está em execução corretamente.

http://localhost:8088/

Se tudo estiver OK, você receberá uma resposta para a requisição semelhante a esta:

{
	"author":{
		"name":"João Pedro de Freitas Brito",
		"website":"https://github.com/joaoplay16"
	},
	"github":"https://github.com/joaoplay16/brazil-university-api",
	"example":"https://brazil-universities-api.herokuapp.com/search"
}

Testes de API

Os testes foram realizados com Jest

Executando os testes

Para rodar os testes execute o comando:

yarn test

ou

yarn test:watch

Licença

Distribuído sob a licença do MIT. Ver LICENSE para mais informações.

Contato

joaoplay16@gmail.com