{"id":51218245,"url":"https://github.com/mmaunze/sigape-api-docs","last_synced_at":"2026-06-28T05:32:18.070Z","repository":{"id":308615924,"uuid":"1033286777","full_name":"mmaunze/sigape-api-docs","owner":"mmaunze","description":"Este projeto fornece uma interface web moderna e interativa para documentar uma API REST (sigape-api-docs) com 647 endpoints organizados em 82 categorias.","archived":false,"fork":false,"pushed_at":"2025-08-06T21:29:05.000Z","size":74,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-06T23:21:57.543Z","etag":null,"topics":["api-rest","documentation","openapi-specification"],"latest_commit_sha":null,"homepage":"https://docs.sigape.cloud","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mmaunze.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-08-06T15:22:30.000Z","updated_at":"2025-08-06T21:29:08.000Z","dependencies_parsed_at":"2025-08-06T23:22:07.456Z","dependency_job_id":null,"html_url":"https://github.com/mmaunze/sigape-api-docs","commit_stats":null,"previous_names":["mmaunze/sigape-api-docs"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/mmaunze/sigape-api-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmaunze%2Fsigape-api-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmaunze%2Fsigape-api-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmaunze%2Fsigape-api-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmaunze%2Fsigape-api-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mmaunze","download_url":"https://codeload.github.com/mmaunze/sigape-api-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmaunze%2Fsigape-api-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34878963,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-28T02:00:05.809Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-rest","documentation","openapi-specification"],"created_at":"2026-06-28T05:32:17.245Z","updated_at":"2026-06-28T05:32:18.063Z","avatar_url":"https://github.com/mmaunze.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Documentação da API - Projeto HTML/CSS/JavaScript\n\nEste projeto fornece uma interface web moderna e interativa para documentar uma API REST (sigape-api-docs) com 647 endpoints organizados em 82 categorias.\n\n## 🚀 Funcionalidades\n\n- **Interface Moderna**: Design responsivo com tema claro/escuro\n- **Busca Inteligente**: Pesquisa em tempo real por endpoints, métodos ou categorias\n- **Filtros por Método**: Filtragem por GET, POST, PUT, DELETE\n- **Navegação Intuitiva**: Sidebar com categorias organizadas por número de endpoints\n- **Detalhes Completos**: Expansão de endpoints com parâmetros e exemplos de código\n- **Syntax Highlighting**: Código JavaScript com destaque de sintaxe\n- **Responsivo**: Funciona perfeitamente em desktop e mobile\n\n## 📁 Estrutura do Projeto\n\n```\nsigape-api-docs/\n├── index.html          # Página principal\n├── styles.css          # Estilos CSS responsivos\n├── script.js           # Funcionalidades JavaScript\n├── organized_api.json  # Dados da API organizados\n└── README.md          # Esta documentação\n```\n\n## 🛠️ Como Usar\n\n### 1. Servidor Local (Recomendado)\n\n```bash\n# Navegue até o diretório do projeto\ncd sigape-api-docs\n\n# Inicie um servidor HTTP local\npython3 -m http.server 8000\n\n# Acesse no navegador\nhttp://localhost:8000\n```\n\n### 2. Servidor Web\n\nFaça upload dos arquivos para qualquer servidor web (Apache, Nginx, etc.) e acesse via URL.\n\n## 🎯 Funcionalidades Principais\n\n### Busca e Filtros\n- Use a barra de pesquisa para encontrar endpoints específicos\n- Filtre por método HTTP usando os botões coloridos\n- Combine busca e filtros para resultados precisos\n\n### Navegação\n- Clique em qualquer categoria na sidebar para ver seus endpoints\n- Use \"Expandir Todos\" / \"Colapsar Todos\" para controlar a visualização\n- Cada endpoint mostra método, caminho e detalhes completos\n\n### Temas\n- Clique no ícone de lua/sol no cabeçalho para alternar temas\n- Preferência salva automaticamente no navegador\n\n## 📊 Estatísticas da API\n\n- **Total de Endpoints**: 664\n- **Categorias**: 74\n- **Métodos Suportados**: GET, POST, PUT, DELETE, PATCH\n- **Principais Categorias**:\n  - Estatísticas: 51 endpoints\n  - Inscrição: 34 endpoints\n  - Pautas: 26 endpoints\n  - Matrículas: 24 endpoints\n\n## 🔧 Tecnologias Utilizadas\n\n- **HTML5**: Estrutura semântica moderna\n- **CSS3**: Grid, Flexbox, Custom Properties, Animações\n- **JavaScript ES6+**: Async/Await, Modules, DOM Manipulation\n- **Font Awesome**: Ícones vetoriais\n- **Prism.js**: Syntax highlighting para código\n\n## 📱 Responsividade\n\nO projeto é totalmente responsivo e funciona em:\n- Desktop (1200px+)\n- Tablet (768px - 1199px)\n- Mobile (até 767px)\n\n## 🎨 Personalização\n\n### Cores e Temas\nEdite as variáveis CSS em `styles.css`:\n\n```css\n:root {\n    --primary-color: #2563eb;\n    --accent-color: #10b981;\n    /* ... outras variáveis */\n}\n```\n\n### Dados da API\nPara usar com sua própria API, substitua o arquivo `organized_api.json` seguindo a estrutura:\n\n```json\n{\n    \"total_endpoints\": 647,\n    \"categories\": {\n        \"categoria_nome\": {\n            \"name\": \"Nome Exibido\",\n            \"description\": \"Descrição da categoria\",\n            \"endpoint_count\": 10,\n            \"endpoints\": [\n                {\n                    \"function_name\": \"getNome\",\n                    \"path\": \"/api/recurso\",\n                    \"method\": \"GET\",\n                    \"parameters\": [\n                        {\n                            \"name\": \"id\",\n                            \"type\": \"path\",\n                            \"description\": \"ID do recurso\"\n                        }\n                    ]\n                }\n            ]\n        }\n    }\n}\n```\n\n## 🐛 Solução de Problemas\n\n### Erro CORS\nSe encontrar erros CORS, certifique-se de servir os arquivos via HTTP server, não file://.\n\n### JavaScript não funciona\nVerifique se todos os arquivos estão no mesmo diretório e o servidor está funcionando.\n\n### Dados não carregam\nConfirme que o arquivo `organized_api.json` está presente e válido.\n\n## 📄 Licença\n\nEste projeto foi criado para documentação de API e pode ser usado livremente para fins educacionais e comerciais.\n\n## 🤝 Contribuições\n\nPara melhorias ou correções:\n1. Identifique o problema ou melhoria\n2. Edite os arquivos apropriados\n3. Teste localmente\n4. Documente as mudanças\n\n---\n\n**Desenvolvido com ❤️ para facilitar a documentação de APIs**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmmaunze%2Fsigape-api-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmmaunze%2Fsigape-api-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmmaunze%2Fsigape-api-docs/lists"}