The Cat API é uma API pública de gerenciamento de informações e imagens de gatos que usaremos de exemplo para a oficina do nosso curso Decolando em TW.
A ideia é que, neste exercício, você escreva documentacões que descrevam como funcionam os enpoints relacionados ao recurso Images do The Cat API.
- Registre-se em https://thecatapi.com/signup para receber sua API key por email.
- A API key deve ser informada no header das chamadas através da variável
x-api-key. - O path a ser utilizado nas chamadas é o https://api.thecatapi.com/v1.
- A API em funcionamento pode ser observada através da coleção do Postman.
O objeto images representa as fotos de gatos enviadas. Imagens que não contiverem gatos ou forem inapropriadas são rejeitadas.
| Nome | Descrição | Tipo | Obrigatório |
|---|---|---|---|
id |
ID da imagem. | UUID |
Sim |
url |
URL para acessar a imagem. | string |
Sim |
width |
Largura da imagem em pixels. Automaticamente gerada. | integer |
Sim |
height |
Altura da imagem em pixels. Automaticamente gerada. | integer |
Sim |
sub_id |
ID para identificação interna. | string |
Não |
created_at |
Data de upload da imagem no formato 2022-11-24T17:41:35.000Z | datetime |
Sim |
original_filename |
Nome do arquivo original. | string |
Sim |
pending |
Flag interna de ciclo de vida. 0=falso, 1=verdadeiro | integer |
Não |
approved |
Flag interna de ciclo de vida. 0=falso, 1=verdadeiro | integer |
Não |
breed_ids |
Não implementado. | N/A | Não |
Endpoint: POST /images/upload
Cria uma nova imagem no sistema carregando um arquivo .gif, .jpg, ou .png válido contendo um gato.
Request body
| Nome | Descrição | Tipo | Obrigatório |
|---|---|---|---|
file |
Arquivo em .gif, .png, ou .jpg | file |
Sim |
sub_id |
ID para identificação interna. | string |
Não |
Endpoint: GET /images/{image_id}
Obtém a imagem correspondente ao parâmetro image_id passado como parâmetro path.
Endpoint: GET /images
Obtenha todas as imagens enviadas para sua conta via /images/upload. Os resultados podem ser filtrados através dos parâmteros query abaixo:
| Parâmetro | Descrição | Tipo | Obrigatório |
|---|---|---|---|
limit |
Número de resultados a serem retornados. O valor máximo é 25. O padrão é 1. | integer |
Sim |
mime_types |
Os tipos de imagem a serem retornados: .gif, .jpg, ou .png. Retorna todos os tipos como padrão. | string delimitado por vírgulas. |
Não |
order |
A ordem de retorno: RANDOM, ASC ou DESC. O padrão é RANDOM. | string |
Não |
Endpoint: DELETE /images/{image_id}
Exclui a imagem correspondente ao parâmetro image_id passado como parâmetro path.