Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/feggah/university-api
This repository contains an Elixir API developed for the discipline SI202 (UNICAMP)
https://github.com/feggah/university-api
api docker elixir unicamp
Last synced: 22 days ago
JSON representation
This repository contains an Elixir API developed for the discipline SI202 (UNICAMP)
- Host: GitHub
- URL: https://github.com/feggah/university-api
- Owner: Feggah
- License: mit
- Created: 2021-08-30T22:14:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-10-27T23:40:18.000Z (about 3 years ago)
- Last Synced: 2023-05-23T04:30:52.945Z (over 1 year ago)
- Topics: api, docker, elixir, unicamp
- Language: Elixir
- Homepage:
- Size: 39.1 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# University API
Esse repositório contém o código-fonte do desafio desenvolvido da discplina Resolução de Problemas da UNICAMP.
A estruturação do repositório está dividida da seguinte maneira:
- A pasta `api` contém todo código em [Elixir](https://elixir-lang.org/);
- Os arquivos `.dockerignore`, `docker-compose.yml`, `Dockerfile` e `entrypoint.sh` estão relacionados a conteinerização da aplicação;
## Como executar a aplicação
Antes de executar a aplicação, você precisará ter instalado o [docker-compose](https://docs.docker.com/compose/). Siga a documentação desse link para efetuar sua instalação.
Agora, com o docker-compose instalado você pode simplesmente rodar em seu terminal a diretiva `make`:
```console
make up
```
Caso você não tenha o `make` instalado, pode utilizar diretamente a linha de comando do `docker-compose`:
```console
docker-compose up
```
Quando os dois conteineres estiverem rodando, a API pode ser acessada através do endpoint `localhost:4000/api/universities`.
Esse endpoint aceita todos os métodos HTTP de CRUD. Para exemplicar os contratos da API, abaixo temos uma resposta de uma listagem através de uma requisição `GET`:
Abaixo está um exemplo de criação de uma universidade. Na imagem abaixo está o `body` da requisição:
E agora a resposta da API para a requisição `POST`:
Verifique que na nova requisição `GET` de listagem a última universidade criada também está contida na resposta:
Para exemplificar a atualização de um valor de uma universidade, abaixo está a atualização do número de alunos da universidade com o ID 2. Primeiramente, o `body` tem o seguinte conteúdo:
> Note que a especificação de qual universidade deve ser atualizada está contida no próprio endpoint da API. Nesse caso, estamos adicionando o ID 2 no final do endpoint.
E essa foi a resposta da requisição de atualização:
Com uma nova requisição de listagem para a verificação da atualização do campo, verifique a imagem abaixo.
O último exemplo de método de CRUD é o `DELETE`. Para isso, iremos deletar a mesma universidade que fizemos a atualização, que é identificada pelo ID 2.
Uma requisição de deleção não contém `body`, a especificação de qual universidade deve ser deletada está no próprio endpoint. Por isso, a requisição foi feita para `localhost:4000/api/universities/2` e a resposta foi:
Com essa universidade deletada, a resposta final da listagem contém apenas 2 universidades:
