Skip to content

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.

License

Notifications You must be signed in to change notification settings

oblipix/Colors-and-Gradients-API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

💻 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:

Captura de tela 2024-10-31 222614

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:

Captura de tela 2024-10-31 222741

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:

Captura de tela 2024-10-31 222830


⚙️ 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:

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

GitHub logo Uma conta no GitHub (opcional, mas recomendado).

Package Icon Instale Dependências: npm install

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

Node.js Icon 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.

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.


📜 Licença

Esse projeto está licenciado sob a MIT License.

About

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.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published