https://github.com/saulosilva/api_example

https://github.com/saulosilva/api_example

Last synced: 19 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/saulosilva/api_example
• Owner: SauloSilva
• Created: 2020-07-27T04:12:54.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-04-11T22:07:28.000Z (over 1 year ago)
• Last Synced: 2024-10-31T10:28:02.449Z (2 months ago)
• Language: Ruby
• Size: 699 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## README

Esta é uma aplicação simples de exemplo de como construir uma API em Rails.

Abaixo você encotrará vários itens para auxiliá-lo a executar esse projeto

## Pré requisitos

Ter instalado na máquina os seguintes recursos com suas respectivas versões:

- Ruby `2.7.1`

- Postgres `11.1`

## Instalação

Depois de obter todos os [pré requisitos](#pré-requisitos), basta executar os seguintes comandos na sequência:

1. `gem install pg -v '1.2.3'`

2. `bin/setup`

Após isso, execute:

`rails s`

Pronto agora é baixar a [collection de endpoints](https://raw.githubusercontent.com/SauloSilva/api_example/master/app/doc/api_example.postman_collection.json) e os environments de [development](https://raw.githubusercontent.com/SauloSilva/api_example/master/app/doc/development.postman_environment.json) e [production](https://raw.githubusercontent.com/SauloSilva/api_example/master/app/doc/production.postman_environment.json) e importar em seu POSTMAN

## Testes

Para executar os testes é necessário ter os [pré requisitos](#pré-requisitos) e também ter finalizado a [instalação](#instalação) das dependências com sucesso.

Sendo assim, agora é so executar o seguinte comando:

`rspec`

## Servidor

A API foi hospedada no heroku.

Esta [neste link](https://api-example-challenge.herokuapp.com).

## Prints das telas

**Exemplo de uma request via POSTMAN**

![](https://github.com/SauloSilva/api_example/raw/master/public/Screen%20Shot%202020-07-27%20at%203.31.45%20AM.png)

![](https://github.com/SauloSilva/api_example/raw/master/public/Screen%20Shot%202020-07-27%20at%202.18.14%20AM.png)

**Demostração da suíte com coverage 100%**

![](https://github.com/SauloSilva/api_example/raw/master/public/Screen%20Shot%202020-07-27%20at%203.04.33%20AM.png)