API de Cores e Gradientes

Descrição

A API de Cores e Gradientes é uma interface RESTful que permite aos desenvolvedores acessar informações sobre cores e gradientes. Ela oferece funcionalidades para listar cores disponíveis, gradientes e sugestões de combinações de cores. É especialmente útil para desenvolvedores front-end que desejam integrar paletas de cores em seus projetos.

Endpoints

1. Listar Cores

◾ URL: /api/colors

◾ Método: GET

Exemplo de Requisição:

GET https://api-cores-gradientes-73qrc073v-oblipixproject.vercel.app/api/colors

Exemplo de Resposta:

2. Listar Gradientes

◾ URL: /api/gradients

◾ Método: GET

◾ Descrição: Retorna uma lista de gradientes disponíveis.

Exemplo de Requisição:

GET https://api-cores-gradientes-73qrc073v-oblipixproject.vercel.app/api/gradients

Exemplo de Requisição:

3. Sugestões de Combinação de Cores:

◾ URL: /api/combinations

◾ Método: GET

◾ Parâmetros: color (obrigatório): A cor em formato HEX para a qual deseja sugestões de combinação. Exemplo: #0077be.

◾ Descrição: Retorna uma lista de sugestões de combinações de cores, excluindo a cor fornecida.

Exemplo de Requisição:

GET https://api-cores-gradientes-73qrc073v-oblipixproject.vercel.app/api/combinations?color=FF5733

(substitua FF5733 por qualquer cor HEX que você queira testar, sem usar o #)

Exemplo de Resposta:

Como Clonar este Repositório

Pré-requisitos:

Important

Antes de executar este projeto, certifique-se de que você possui as seguintes ferramentas instaladas em sua máquina:

Ter o Git instalado no seu computador. Se ainda não tiver, baixe e instale o Git.

Uma conta no GitHub (opcional, mas recomendado).

Instale Dependências: npm install

Faça um Fork do repositório, assim nada será alterado do repositório original.

A API foi desenvolvida utilizando o Node.js. É recomendável instalar a versão mais recente do Node.js.

Tip

Cliente HTTP (opcional): Para testar a API, você pode usar um cliente HTTP como Postman ou Insomnia, ou até mesmo o terminal com curl.

Vamos clonar este repositório passo a passo.

Obtenha a URL do repositório:

https://github.com/oblipix/Colors-and-Gradients-API.git

navegue até a pasta onde deseja clonar.

Clone o repositório:

git clone https://github.com/oblipix/Colors-and-Gradients-API.git

_{Agora você tem uma cópia local do repositório que pode ser modificada conforme necessário.}