Skip to content

Melhorar documentacao da API com exemplos de uso #6

Description

@AndersonOtimiza

Descricao

A API da Biblia Belem An.C esta funcional em https://biblia.aculpaedasovelhas.org mas a documentacao pode ser melhorada com exemplos praticos.

Tarefas

  • Adicionar exemplos de curl/fetch para cada endpoint
  • Documentar parametros de query (busca, filtros)
  • Adicionar exemplos em Python, JavaScript e cURL
  • Criar secao "Quick Start" no README

Endpoints principais

  • GET /api/books - Lista livros
  • GET /api/books/:id/chapters - Capitulos de um livro
  • GET /api/verses/:book/:chapter - Versiculos
  • GET /api/search?q= - Busca textual
  • GET /api/glossary - Glossario

Como contribuir

  1. Teste os endpoints na API de producao
  2. Escreva exemplos claros e funcionais
  3. Submeta um PR atualizando o README.md

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions