/tse-apidoc

Documentação da API do sistema "Divulgação de Candidaturas e Contas Eleitorais"

Primary LanguageHTML

Documentação da API de Divulgação de Candidaturas do TSE

API Version 1 Swagger 3.20.6

Esse projeto faz o mapeamento da API do sistema Divulgação de Candidaturas e Contas Eleitorais para acesso aos dados públicos do TSE para coleta de dados, entre outros. Nele possui dados complementares que no repositório de dados do TSE como imagem do candidato, entre outros.

Imagem do Site

Essa documentação é feita usando o Swagger na versão 3.20.6 por meio do Swagger Editor.

Como contribuir

O front-end do sistema é feito com Angular 1.x, dessa forma, pode usar o DevTools do seu browser para verificar as chamadas a API, ou também investigar o código-fonte do app, para entender como é requisitado e enviado os dados para consulta.

Caso encontrei algum endpoint que não estiver documentado, para contribuir é só fazer o fork desse projeto, editar o arquivo swagger.yaml respeitando o formato que o Swagger define, e mandar em um novo Pull Request.