Skip to content

API_REFERENCE.md

Latest commit

 

History

History
293 lines (217 loc) · 13.7 KB

API_REFERENCE.md

File metadata and controls

293 lines (217 loc) · 13.7 KB
Raw

📚 API Reference — GlassHub Quasar

Guia completo e ilustrado de todos os endpoints HTTP do GlassHub Quasar. Todas as rotas retornam imagens nativas em formato image/svg+xml.

📑 Sumário dos Endpoints

  1. /api/title
  2. /api/socials
  3. /api/tech-stack
  4. /api/activity-graph
  5. /api/stats
  6. /api/top-langs
  7. /api/streak
  8. /api/repo
  9. /api/wakatime
  10. /api/quote
  11. /api/badge
  12. /api/image-filter
  13. /api/card
  14. /api/table
  15. /api/logo
  16. /api/icon

1. /api/stats — Métricas de Perfil GitHub

Gera um card completo com commits, PRs, issues criadas, estrelas acumuladas e anel de Rank orbital.

![GitHub Stats](https://glasshub-quasar.vercel.app/api/stats?username=matheustheus27&theme=glass-dark)

Parâmetros HTTP:

Parâmetro Tipo Padrão Descrição
username string octocat Nome de usuário no GitHub
theme string glass-dark Tema (glass-dark, glass-light, cosmic-cyan, cyber-purple, emerald-matrix, solar-flare)
show_icons boolean true Exibe ícones ao lado de cada métrica
hide_rank boolean false Oculta o anel de classificação orbital
auto_theme boolean false Adapta automaticamente ao tema escuro/claro do GitHub
border_radius number 18 Raio das bordas do card

2. /api/top-langs — Linguagens Mais Usadas

Renderiza a distribuição de linguagens de programação baseada nos repositórios do usuário.

![Top Languages](https://glasshub-quasar.vercel.app/api/top-langs?username=matheustheus27&layout=bars&theme=glass-dark)

Parâmetros HTTP:

Parâmetro Tipo Padrão Descrição
username string octocat Nome de usuário no GitHub
layout string bars Estilo de exibição (bars, donut, compact)
limit number 5 Número máximo de linguagens exibidas (1 a 8)
theme string glass-dark Tema visual

3. /api/streak — Sequência de Contribuições

Exibe a sequência de dias consecutivos codificando (current streak), maior sequência histórica (longest streak) e total de contribuições.

![Contribution Streak](https://glasshub-quasar.vercel.app/api/streak?username=matheustheus27&theme=glass-dark&glow=true)

Parâmetros HTTP:

Parâmetro Tipo Padrão Descrição
username string octocat Nome de usuário no GitHub
theme string glass-dark Tema visual
glow boolean true Ativa o efeito neon incandescente no fogo de streak

4. /api/repo — Card de Repositório em Destaque

Gera um card para destacar um repositório individual com estrelas, forks, linguagem e licença.

![Pinned Repo](https://glasshub-quasar.vercel.app/api/repo?username=matheustheus27&repo=GlassHubQuasar&theme=glass-dark)

5. /api/wakatime — Tempo de Código WakaTime

Exibe o tempo total e diário de codificação e linguagens mais utilizadas registradas no WakaTime.

![WakaTime Stats](https://glasshub-quasar.vercel.app/api/wakatime?username=octocat&theme=glass-dark)

6. /api/quote — Frases Diárias de Dev

Exibe frases inspiradoras sobre desenvolvimento de software com rotação diária ou texto customizado.

![Dev Quote](https://glasshub-quasar.vercel.app/api/quote?theme=glass-dark)

10. /api/table — Tabelas & Matrizes de Arquitetura

Renderiza uma matriz/tabela estilizada com calculador inteligente de largura de colunas por conteúdo e isolamento clip-path para evitar sobreposição de textos.

![Tech Stack Table](https://glasshub-quasar.vercel.app/api/table?title=Core+Stack+%26+Architecture&columns=Layer,Technology,Status&rows=Frontend,Next.js+14+%2F+React+18,Production;Engine,Dynamic+SVG+%2F+Edge,Online;Design,Glassmorphism+Neon,Active)

Parâmetros HTTP:

Parâmetro Tipo Padrão Descrição
title string Tech Stack & Architecture Título da tabela
columns string Layer,Technology,Status Cabeçalhos separados por vírgula
rows string ... Linhas separadas por ponto e vírgula ; e colunas por vírgula ,
col_widths string — (Opcional) Porcentagens (30,50,20) ou pixels (140,240,100) para cada coluna
width string 540 Largura total em px (auto-expande se necessário)
theme string glass-dark Tema visual

11. /api/logo — Logos Vetoriais Animados do Ecossistema

Gera a logo oficial em SVG animado com efeito Glassmorphic, brilhos neon e animações CSS para qualquer projeto do Ecossistema GlassHub:

![GlassHub Quasar Logo](https://glasshub-quasar.vercel.app/api/logo?project=quasar&animated=true&width=160&height=160)
![GlassHub Nebula Logo](https://glasshub-quasar.vercel.app/api/logo?project=nebula&animated=true&width=160&height=160)
![GlassHub Pulsar Logo](https://glasshub-quasar.vercel.app/api/logo?project=pulsar&animated=true&width=160&height=160)
![GlassHub Catalyst Logo](https://glasshub-quasar.vercel.app/api/logo?project=catalyst&animated=true&width=160&height=160)
![GlassHub Nexus Logo](https://glasshub-quasar.vercel.app/api/logo?project=nexus&animated=true&width=160&height=160)
![GlassHub Prism Logo](https://glasshub-quasar.vercel.app/api/logo?project=prism&animated=true&width=160&height=160)
![GlassHub Event Horizon Logo](https://glasshub-quasar.vercel.app/api/logo?project=eventhorizon&animated=true&width=160&height=160)

Parâmetros HTTP:

Parâmetro Tipo Padrão Descrição
project / name string quasar Projeto do ecossistema (quasar, nebula, pulsar, catalyst, nexus, prism, eventhorizon)
animated boolean true Ativa rotação de discos cósmicos, pulsação de nós quânticos e emissão de jatos
width number 300 Largura em pixels
height number 300 Altura em pixels
theme string glass-dark Tema visual

🎨 Parâmetros de Customização de Cores Hex (Theme Studio)

Em qualquer um dos endpoints, você pode sobrescrever cores individuais passando parâmetros hexadecimais (sem a tralha #):

![Custom Theme](https://glasshub-quasar.vercel.app/api/stats?username=matheustheus27&bg=0f172a&border=06b6d4&text=ffffff&glow_color=06b6d4)
  • bg: Cor de fundo em Hex
  • border: Cor da borda
  • text: Cor dos textos principais
  • glow_color: Cor dos brilhos neon e ícones

12. /api/icon — Card de Ícone Dinâmico

Gera um mini card/ícone vetorial totalmente dinâmico com suporte a ícones predefinidos, monogramas de texto (iniciais) ou caminho SVG arbitrário (path).

![Dynamic Icon](https://glasshub-quasar.vercel.app/api/icon?initials=GH&label=GlassHub&theme=glass-dark&shape=circle)

Parâmetros HTTP:

Parâmetro Tipo Padrão Descrição
icon string sparkles Slug do ícone predefinido (linkedin, glasshub, react, github, etc.)
initials / text string — Monograma dinâmico de 1 a 3 letras (ex: GH, JS, 42)
svg_path / path string — Caminho <path d="..." /> SVG arbitrário customizado
label string "" Título exibido abaixo do ícone
sublabel string "" Subtítulo opcional
shape string rounded Formato da moldura de vidro (rounded, circle, square, pill)
size number 140 Dimensão da caixa do ícone em pixels
glow boolean true Ativa o efeito neon incandescente
theme string glass-dark Tema visual

13. /api/title — Títulos e Cabeçalhos

Gera banners de título, nomes e cabeçalhos de seção estilizados em Glassmorphism para perfis e documentações.

![Title Header](https://glasshub-quasar.vercel.app/api/title?title=Matheus+Ferreira&subtitle=Fullstack+Engineer&icon=sparkles&theme=glass-dark&preset=glass-banner&animated=true)

Parâmetros HTTP:

Parâmetro Tipo Padrão Descrição
title / text / name string Matheus Ferreira Texto do título principal
subtitle / tagline string Fullstack Engineer... Subtítulo opcional
icon string sparkles Slug do ícone ou monograma
preset / style string glass-banner Estilo do banner (glass-banner, neon-glow, minimal-line, badge-title, cyber-tech)
align string center Alinhamento do texto (center, left, right)
theme string glass-dark Tema visual
animated boolean false Ativa animações do ecossistema GlassHub
auto_theme boolean false Adapta automaticamente ao tema claro/escuro

14. /api/socials — Bar de Redes Sociais & Contato

Renderiza um banner horizontal em Glassmorphism com badges dinâmicas das suas redes sociais e contatos.

![Socials Connect Bar](https://glasshub-quasar.vercel.app/api/socials?github=matheustheus27&linkedin=matheustheus27&website=glasshub.dev&theme=glass-dark&animated=true)

Parâmetros HTTP:

Parâmetro Tipo Padrão Descrição
github string — Handle/username do GitHub
linkedin string — Username do LinkedIn
website / site string — URL do portfólio ou site pessoal
email / mail string — Endereço de e-mail de contato
twitter / x string — Handle do Twitter/X
discord string — Tag/username do Discord
youtube string — Canal do YouTube
bluesky / bsky string — Handle do Bluesky
theme string glass-dark Tema visual
animated boolean true Ativa animação de luz neon no hover

15. /api/tech-stack — Grid de Tecnologias & Skills

Exibe uma grade interativa de tecnologias em caixas translúcidas com ícones neon.

![Tech Stack Grid](https://glasshub-quasar.vercel.app/api/tech-stack?title=Tech+Stack&skills=nextjs,react,typescript,python,docker,postgresql,tailwind,rust&theme=glass-dark&animated=true)

Parâmetros HTTP:

Parâmetro Tipo Padrão Descrição
title string Tech Stack & Skills Título da seção
skills / tech string nextjs,react,... Chaves de linguagens/ferramentas separadas por vírgula
columns / cols number 4 Número de colunas na grade (2 a 6)
theme string glass-dark Tema visual
animated boolean true Ativa animação de pulsação nos ícones

16. /api/activity-graph — Gráfico de Contribuições 30 Dias

Renderiza um gráfico de barras estilo Glassmorphism com colunas translúcidas representando o ritmo de código.

![Activity Graph](https://glasshub-quasar.vercel.app/api/activity-graph?username=matheustheus27&theme=glass-dark&animated=true)

Parâmetros HTTP:

Parâmetro Tipo Padrão Descrição
username string octocat Nome de usuário no GitHub
theme string glass-dark Tema visual
animated boolean true Ativa animação de iluminação nas colunas

🎨 Catálogo Completo de Ícones Vetoriais Nativo (icon)

Todos os endpoints que aceitam o parâmetro icon (como /api/badge, /api/icon, /api/card, /api/stats, /api/title) suportam os seguintes slugs nativos:

Categoria Slugs de Ícones Suportados
Ecossistema GlassHub glasshub / portal (Portal / Landing Page), quasar (GitHub Stats), nebula (Graphics), pulsar (Resume CV), catalyst (Documentation), nexus (P2P Comm), prism (Email Signature), eventhorizon (File Compression)
Dev Tools & Plataformas github, gitlab, npm, figma, vscode, license, shell, cli, gui
Deploy & Nuvem vercel, cloudflare, netlify, aws, firebase, docker, git, linux, android, windows, mac
Redes Sociais & Contato linkedin, twitter, instagram, youtube, discord, telegram, whatsapp, email, bluesky, website, stackoverflow
Linguagens de Programação typescript, javascript, python, rust, go, java, php, kotlin, csharp, cpp, wasm
Frameworks & Web react, nextjs, vue, angular, svelte, tailwind, nodejs, vite, motion, vulkan
Bancos de Dados & APIs postgresql, mongodb, mysql, redis, graphql, database
Métricas & Utilitários star, commit, pr, issue, trophy, sparkles, gear, icons, qrcode, lock

💡 Monograma de Fallback: Se você informar um nome que não esteja na lista, a API gera dinamicamente um monograma translúcido de 2 letras (ex: icon=suaempresa -> gera as iniciais SU).