Skip to content

biancamota/desafio-api

Repository files navigation

Sobre

A API pública desenvolvida em PHP com Laravel que consome os dados de outra API externa https://api.reddit.com/r/artificial/hot salvando-os em uma base para posterior consulta através de dois endpoints. É possível consultar as postagens em um determinado período de tempo e seus authores. Um comando foi gerado para chamar a api externa todos os dias as 6h.

Utilização

🎲 Rodando o projeto

# Clone este repositório
$ git clone <[email protected]:biancamota/desafio-api.git>

# Acesse a pasta do projeto
$ cd desafio-api

Abra no seu editor de código, abra o arquivo env.example, edite com as suas configurações de ambiente e salve com .env image

# Rode as migrations
$ php artisan migrate

# Rode este comando para popular a tabela
$ php artisan StoreDataApi:generate

# Execute a aplicação 
$ php artisan serve

# O servidor inciará na porta:8000 - acesse <http://127.0.0.1:8000>

Chamando a api

posts

image

Retorna as postagens criadas dentro do período informado em ordem decrescente seguindo a ordenação estipulada

Atributo Tipo Obrigatoriedade Descrição
initial_date string Sim Data inicial do período no formato yyyy-mm-dd
final_date string Sim Data final do período no formato yyyy-mm-dd
order integer Opcional Informe 1 para ordenar pela quantidade de "ups" ou 2 para ordenadar pela quantidade de comentários. Se o parametro não for passado, será considerado 1.

image

authors

image

Retorna uma lista de autores em ordem decrescente seguindo a ordenação estipulada

Atributo Tipo Obrigatoriedade Default Descrição
order integer Opcional 1 Informe 1 para ordenar pela quantidade de "ups" ou 2 para ordenadar pela quantidade de comentários

image

About

Desafio proposto para consumir e criar uma API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages