Skip to content

Commit 4160728

Browse files
Atticus64Atticus64
committed
docs: agregar documentacion formal generada con opencode
1 parent af94bb0 commit 4160728

13 files changed

Lines changed: 5179 additions & 25 deletions

‎README.md‎

Lines changed: 93 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,79 @@
1-
# Bible API
1+
# Bible API / API Bíblica
22

33
> [!NOTE]
4-
> This api is still in development, if you found an bug or want to request for documentation. create a issue in this repository
4+
> This API is still in development. If you found a bug or want to request documentation, create an issue in this repository.
5+
>
6+
> Esta API aún está en desarrollo. Si encuentras un bug o deseas solicitar documentación, crea un issue en este repositorio.
7+
8+
## Documentation / Documentación
9+
10+
| Document | Descripción |
11+
|----------|-------------|
12+
| [Architecture / Arquitectura](docs/architecture.md) | Project structure, flow diagrams, and layers / Estructura del proyecto, diagramas de flujo y capas |
13+
| [API Reference / Referencia de API](docs/api-reference.md) | Complete endpoint documentation / Documentación completa de todos los endpoints |
14+
| [Authentication / Autenticación](docs/authentication.md) | Registration, login, and protected endpoints guide / Guía de registro, login y endpoints protegidos |
15+
| [Data Models / Modelos de Datos](docs/data-models.md) | Schemas, types, and database structure / Esquemas, tipos y estructura de bases de datos |
16+
17+
## Examples / Ejemplos
18+
19+
| Language / Lenguaje | File / Archivo |
20+
|---------------------|----------------|
21+
| [cURL](docs/examples/curl.md) | HTTP request examples with curl |
22+
| [Python](docs/examples/python.md) | Examples with `requests` and `asyncio` |
23+
| [JavaScript](docs/examples/javascript.md) | Examples with `fetch` (Node.js and browser) |
24+
| [Go](docs/examples/golang.md) | Examples with `net/http` and full client |
25+
| [Elixir](docs/examples/elixir.md) | Examples with `Req`, `Task`, and GenServer |
26+
| [Java](docs/examples/java.md) | Examples with `HttpClient` (Java 11+) and Jackson |
27+
| [C#](docs/examples/csharp.md) | Examples with `HttpClient` and `System.Text.Json` |
28+
29+
## Available Bible Versions / Versiones Disponibles
30+
31+
| Code | Name / Nombre |
32+
|------|---------------|
33+
| `rv1960` | Reina Valera 1960 |
34+
| `rv1995` | Reina Valera 1995 |
35+
| `nvi` | Nueva Versión Internacional |
36+
| `dhh` | Dios Habla Hoy |
37+
| `pdt` | Palabra de Dios para Todos |
38+
| `kjv` | King James Version |
39+
40+
---
541

642
## Endpoints
743

8-
_Get chapter book_
44+
_Get chapter book / Obtener capítulo de libro_
945

10-
`/api/read/<version>/<book>/<chapter`
46+
```
47+
/api/read/<version>/<book>/<chapter>
48+
```
1149

1250
```ts
1351
enum Version {
1452
"rv1960",
1553
"rv1995",
16-
"dhh"
17-
"nvi"
54+
"dhh",
55+
"nvi",
56+
"pdt",
57+
"kjv"
1858
}
1959
```
2060

21-
`/api/read/rv1960/<book>/<chapter>`
22-
23-
`/api/read/rv1960/<book>/<chapter>`
61+
- Examples / Ejemplos
2462

25-
- Examples
26-
27-
https://bible-api.deno.dev/api/read/rv1960/genesis/1
28-
29-
GET `/api/read/rv1960/genesis/1`
63+
```
64+
GET /api/read/rv1960/genesis/1
65+
GET /api/read/nvi/apocalipsis/22
66+
```
3067

31-
GET `/api/read/nvi/apocalipsis/22`
68+
Live example: https://bible-api.deno.dev/api/read/rv1960/genesis/1
3269

33-
### Search query
70+
### Search query / Búsqueda
3471

35-
`api/read/<version>/search?q=Dios&testament=old&take=5&page=4`
72+
```
73+
/api/read/<version>/search?q=Dios&testament=old&take=5&page=4
74+
```
3675

37-
_query is required_
76+
_query is required / query es requerido_
3877

3978
```ts
4079
interface Parameters {
@@ -45,22 +84,51 @@ interface Parameters {
4584
}
4685
```
4786

48-
- Examples
87+
- Examples / Ejemplos
4988

50-
https://bible-api.deno.dev/api/read/nvi/search?q=Dios
89+
```
90+
GET /api/read/nvi/search?q=Dios
91+
GET /api/read/nvi/search?q=Dios&page=2
92+
GET /api/read/nvi/search?q=Dios&page=2&take=3
93+
```
5194

52-
GET `api/nvi/read/search?q=Dios&page=2`
95+
Live example: https://bible-api.deno.dev/api/read/nvi/search?q=Dios
5396

54-
GET `api/nvi/read/search?q=Dios&page=2&take=3`
97+
---
5598

56-
## Dev server
99+
## Quick Start / Inicio Rápido
57100

101+
### Get Genesis 1 (Reina Valera 1960) / Obtener Génesis 1 (Reina Valera 1960)
102+
103+
```bash
104+
curl https://bible-api.deno.dev/api/read/rv1960/genesis/1
58105
```
59-
deno task dev
106+
107+
### Search "Dios" in NVI / Buscar "Dios" en NVI
108+
109+
```bash
110+
curl "https://bible-api.deno.dev/api/read/nvi/search?q=Dios&testament=old&take=5"
60111
```
61112

62-
## Scrape
113+
## Technologies / Tecnologías
114+
115+
- **Runtime:** [Deno](https://deno.land/)
116+
- **Framework:** [Hono](https://hono.dev/)
117+
- **Database (verses):** PostgreSQL
118+
- **Database (users/notes):** Deno KV
119+
- **Validation:** [Zod](https://zod.dev/)
120+
- **Authentication:** JWT with `jose`
63121

122+
## Development / Desarrollo
123+
124+
### Dev server / Servidor de desarrollo
125+
126+
```bash
127+
deno task dev
64128
```
129+
130+
### Scrape / Scraping
131+
132+
```bash
65133
deno task scrape
66134
```

‎docs/README.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Bible API - Documentación
2+
3+
API REST para consultar textos bíblicos en múltiples versiones en español e inglés.
4+
5+
> **Nota:** Esta API está en desarrollo. Si encuentras un bug o deseas solicitar documentación, crea un issue en el repositorio.
6+
7+
## Tabla de Contenidos
8+
9+
| Documento | Descripción |
10+
|-----------|-------------|
11+
| [Arquitectura](architecture.md) | Estructura del proyecto, diagramas de flujo y capas |
12+
| [Referencia de API](api-reference.md) | Documentación completa de todos los endpoints |
13+
| [Autenticación](authentication.md) | Guía de registro, login y endpoints protegidos |
14+
| [Modelos de Datos](data-models.md) | Esquemas, tipos y estructura de bases de datos |
15+
16+
## Ejemplos de Uso
17+
18+
| Lenguaje | Archivo |
19+
|----------|---------|
20+
| [cURL](examples/curl.md) | Ejemplos de peticiones HTTP con curl |
21+
| [Python](examples/python.md) | Ejemplos con la librería `requests` y `asyncio` |
22+
| [JavaScript](examples/javascript.md) | Ejemplos con `fetch` (Node.js y navegador) |
23+
| [Go](examples/golang.md) | Ejemplos con `net/http` y cliente completo |
24+
| [Elixir](examples/elixir.md) | Ejemplos con `Req`, `Task` y GenServer |
25+
| [Java](examples/java.md) | Ejemplos con `HttpClient` (Java 11+) y Jackson |
26+
| [C#](examples/csharp.md) | Ejemplos con `HttpClient` y `System.Text.Json` |
27+
28+
## Versiones Disponibles
29+
30+
| Código | Nombre |
31+
|--------|--------|
32+
| `rv1960` | Reina Valera 1960 |
33+
| `rv1995` | Reina Valera 1995 |
34+
| `nvi` | Nueva Versión Internacional |
35+
| `dhh` | Dios Habla Hoy |
36+
| `pdt` | Palabra de Dios para Todos |
37+
| `kjv` | King James Version |
38+
39+
## Inicio Rápido
40+
41+
### Servidor de desarrollo
42+
43+
```bash
44+
deno task dev
45+
```
46+
47+
### Ejemplo: Obtener Génesis 1 (Reina Valera 1960)
48+
49+
```bash
50+
curl https://bible-api.deno.dev/api/read/rv1960/genesis/1
51+
```
52+
53+
### Ejemplo: Buscar "Dios" en NVI
54+
55+
```bash
56+
curl "https://bible-api.deno.dev/api/read/nvi/search?q=Dios&testament=old&take=5"
57+
```
58+
59+
## Tecnologías
60+
61+
- **Runtime:** [Deno](https://deno.land/)
62+
- **Framework:** [Hono](https://hono.dev/)
63+
- **Base de datos (versículos):** PostgreSQL
64+
- **Base de datos (usuarios/notas):** Deno KV
65+
- **Validación:** [Zod](https://zod.dev/)
66+
- **Autenticación:** JWT con `jose`

0 commit comments

Comments
 (0)