https://github.com/oblipix/colors-and-gradients-api
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.
https://github.com/oblipix/colors-and-gradients-api
api colors colors-and-gradients-api cor front-end front-end-development frontend gradientes gradients nodejs
Last synced: 7 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/oblipix/colors-and-gradients-api
- Owner: oblipix
- License: mit
- Created: 2024-11-01T00:05:23.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-12-11T12:36:28.000Z (10 months ago)
- Last Synced: 2025-01-21T14:46:25.822Z (9 months ago)
- Topics: api, colors, colors-and-gradients-api, cor, front-end, front-end-development, frontend, gradientes, gradients, nodejs
- Language: JavaScript
- Homepage: https://api-cores-gradientes.vercel.app/
- Size: 18.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## 💻 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.
>
**Clone o repositório:**
```diff
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.