Reviews API

A API de avaliações do Codante.io é uma api que simula uma lista de avaliações de produtos em uma plataforma. Traz suporte para uma variedade de parâmetros de consulta, como busca textual por nome, ordenação, e filtragem por número de estrelas. A API responde com um código de status 200 para solicitações bem-sucedidas, fornecendo um array de recursos de avaliação no formato JSON, cada um contendo informações detalhadas, como ID da avaliação, nome do avaliador, descrição, número de estrelas e data de criação.

Além disso, a API inclui tratamento adequado para solicitações inválidas, retornando um código de status 422 quando os parâmetros fornecidos são incorretos ou insuficientes.

Autenticação

A API de avaliações do Codante.io não requer autenticação para acessar as avaliações.

Rate Limit

A API de avaliações do Codante.io possui um limite de taxa de 100 solicitações por minuto. Se você exceder esse limite, receberá um código de status 429. O uso indiscriminado também poderá levar ao bloqueio do seu IP.

Base URL

A URL base para a API de avaliações do Codante.io é https://apis.codante.io/api/reviews-api.

O model Review (Avaliação)

O model Review traz todas as informações sobre uma avaliação.

Propriedades

Name
id
Type
integer
Description
Identificador único da avaliação.
Name
name
Type
string
Description
Nome do avaliador.
Name
description
Type
string
Description
Texto da avaliação.
Name
stars
Type
integer
Description
Número de estrelas da avaliação (1-5).
Name
created_at
Type
timestamp
Description
Data e hora de criação da avaliação.

GET/reviews-api/reviews

Listagem de avaliações

Este endpoint permite que você recupere uma lista paginada de todas as avaliações. Por padrão, um máximo de dez avaliações são mostradas por página.

Atributos opcionais

Name
page
Type
integer
Description
Número da página a ser recuperada.
Name
stars
Type
integer
Description
Filtra as avaliações por número de estrelas (1-5).
Name
sort
Type
string
Description
Ordena as avaliações por um campo específico. Pode ser name, stars, ou created_at. O padrão é created_at.
Para ordenação decrescente, adicione um sinal de menos (-) antes do nome do campo.
Name
search
Type
string
Description
Filtra as avaliações por um termo de busca textual (nome do avaliador ou descrição).

Request

GET

/reviews-api/reviews

curl -G https://apis.codante.io/api/reviews-api/reviews \
  -d page=1

Response

{
  "data": [
    {
      "id": 1,
      "name": "Bruno M.",
      "description": "Surpreendentemente confortável e com um som maravilhoso, valeu cada centavo! A qualidade sonora é impressionante, e o design é sofisticado. Uso tanto no trabalho quanto em casa.",
      "stars": 5,
      "created_at": "2024-10-01T13:00:03.000000Z"
    },
    // ... more reviews
  ],
  "links": {
    "first": "https://apis.codante.io/api/reviews-api/reviews?page=1",
    "last": "https://apis.codante.io/api/reviews-api/reviews?page=30",
    "prev": null,
    "next": "https://apis.codante.io/api/reviews-api/reviews?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 30,
    "path": "https://apis.codante.io/api/reviews-api/reviews",
    "per_page": 10,
    "to": 10,
    "total": 300
  }
}

GET/reviews-api/reviews/{id}

Avaliação Individual

Este endpoint permite que você visualize uma única avaliação.

Request

GET

/reviews-api/reviews/{id}

curl -G https://apis.codante.io/api/reviews-api/reviews/1 \

Response

{
  "data": {
    "id": 1,
    "name": "Bruno M.",
    "description": "Surpreendentemente confortável e com um som maravilhoso, valeu cada centavo! A qualidade sonora é impressionante, e o design é sofisticado. Uso tanto no trabalho quanto em casa.",
    "stars": 5,
    "created_at": "2024-10-01T13:00:03.000000Z"
  }
}

DELETE/reviews-api/reviews/{id}

Apagar Avaliação

Este endpoint permite que você apague uma avaliação. Caso a avaliação não exista, um código de status 404 será retornado.

Request

DELETE

/reviews-api/reviews/{id}

curl -X "DELETE" https://apis.codante.io/api/reviews-api/reviews/1 \

POST/reviews-api/reviews

Criar Avaliação

Este endpoint permite que você crie uma nova avaliação. Caso a avaliação seja criada com sucesso, um código de status 201 será retornado. Caso contrário, um código de status 422 será retornado.

Parâmetros

Name
name
Type
string
Description
Nome do avaliador.
Name
description
Type
string
Description
Texto da avaliação.
Name
stars
Type
integer
Description
Número de estrelas da avaliação (1-5).

Request

POST

/reviews-api/reviews

curl -X "POST" https://apis.codante.io/api/reviews-api/reviews \
  -d "name=Bruno M." \
  -d "description=Surpreendentemente confortável e com um som maravilhoso, valeu cada centavo!" \
  -d "stars=5"