Skip to content

Atticus64/BibleApi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

129 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Bible API / API Bíblica

Note

This API is still in development. If you found a bug or want to request documentation, create an issue in this repository.

Esta API aún está en desarrollo. Si encuentras un bug o deseas solicitar documentación, crea un issue en este repositorio.

Documentation / Documentación

Document Descripción
Architecture / Arquitectura Project structure, flow diagrams, and layers / Estructura del proyecto, diagramas de flujo y capas
API Reference / Referencia de API Complete endpoint documentation / Documentación completa de todos los endpoints
Authentication / Autenticación Registration, login, and protected endpoints guide / Guía de registro, login y endpoints protegidos
Data Models / Modelos de Datos Schemas, types, and database structure / Esquemas, tipos y estructura de bases de datos

Examples / Ejemplos

Language / Lenguaje File / Archivo
cURL HTTP request examples with curl
Python Examples with requests and asyncio
JavaScript Examples with fetch (Node.js and browser)
Go Examples with net/http and full client
Elixir Examples with Req, Task, and GenServer
Java Examples with HttpClient (Java 11+) and Jackson
C# Examples with HttpClient and System.Text.Json

Available Bible Versions / Versiones Disponibles

Code Name / Nombre
rv1960 Reina Valera 1960
rv1995 Reina Valera 1995
nvi Nueva Versión Internacional
dhh Dios Habla Hoy
pdt Palabra de Dios para Todos
kjv King James Version

Endpoints

Get chapter book / Obtener capítulo de libro

/api/read/<version>/<book>/<chapter>
enum Version {
  "rv1960",
  "rv1995",
  "dhh",
  "nvi",
  "pdt",
  "kjv"
}
  • Examples / Ejemplos
GET /api/read/rv1960/genesis/1
GET /api/read/nvi/apocalipsis/22

Live example: https://bible-api.deno.dev/api/read/rv1960/genesis/1

Search query / Búsqueda

/api/read/<version>/search?q=Dios&testament=old&take=5&page=4

query is required / query es requerido

interface Parameters {
  q: string
  testament?: string
  take?: number
  page?: number
}
  • Examples / Ejemplos
GET /api/read/nvi/search?q=Dios
GET /api/read/nvi/search?q=Dios&page=2
GET /api/read/nvi/search?q=Dios&page=2&take=3

Live example: https://bible-api.deno.dev/api/read/nvi/search?q=Dios


Quick Start / Inicio Rápido

Get Genesis 1 (Reina Valera 1960) / Obtener Génesis 1 (Reina Valera 1960)

curl https://bible-api.deno.dev/api/read/rv1960/genesis/1

Search "Dios" in NVI / Buscar "Dios" en NVI

curl "https://bible-api.deno.dev/api/read/nvi/search?q=Dios&testament=old&take=5"

Technologies / Tecnologías

  • Runtime: Deno
  • Framework: Hono
  • Database (verses): PostgreSQL
  • Database (users/notes): Deno KV
  • Validation: Zod
  • Authentication: JWT with jose

Development / Desarrollo

Dev server / Servidor de desarrollo

deno task dev

Scrape / Scraping

deno task scrape

Releases

No releases published

Packages

 
 
 

Contributors