https://github.com/gpalleschi/holybible_api

Bible API RESTful Node.js based Multilingual (Italian, Spanish, French, German, English, Portuguese)
https://github.com/gpalleschi/holybible_api

bible bibleapi javascript knexjs multilingual nodejs restful-api sqlite3

Last synced: 6 months ago
JSON representation

Bible API RESTful Node.js based Multilingual (Italian, Spanish, French, German, English, Portuguese)

Host: GitHub
URL: https://github.com/gpalleschi/holybible_api
Owner: gpalleschi
License: gpl-3.0
Created: 2022-03-30T16:36:05.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-11-10T16:52:06.000Z (11 months ago)
Last Synced: 2024-11-10T17:38:49.948Z (11 months ago)
Topics: bible, bibleapi, javascript, knexjs, multilingual, nodejs, restful-api, sqlite3
Language: JavaScript
Homepage:
Size: 15.4 MB
Stars: 8
Watchers: 2
Forks: 2
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# holybible_api
Bible API RESTful Node.js based Multilingual (Italian, Spanish, French, German, English and Portuguese) is a free, open source bible api to get verses, chapters or search words or sentence.

## API Reference

- [Get Versions](#Versions)
- [Get Books](#Books)
- [Find verses](#Find)
- [Random verse](#Random)
- [Search a word or a sentence](#Search)
- [Error Managment](#Error-Managment)

## Versions

```HTTP
GET /versions
```

Return all bible versions loaded.

**Query parameters**

None

**Response**

```ts
{
versions: array<{
// Language code
language: string
// Bible version name
name: string
// Flag default
default: string
// Bible version description
description: string
// Bible version detail info
detail_info: string
// Bible version file name
file: string
}>
}
```
**Examples**

`http://localhost:35907/versions`

```
{
"versions": [
{
"language": "it",
"name": "NR94",
"default": "Y",
"description": "Nuova Riveduta 1994",
"detailed_info": "Copyright © 1994 by Geneva Bible Society",
"file": "NR94.SQLite3"
},
{
"language": "en",
"name": "ESV",
"default": "Y",
"description": "English Standard Version 2001, 2016",
"detailed_info": "The Holy Bible, English Standard Version. Copyright © 2001 by Crossway Bibles, a publishing ministry of Good News Publishers.",
"file": "ESV.SQLite3"
},
...
...
]
}
```

## Books

```HTTP
GET /books
```

Return all books available.

**Query parameters**

**Response**

```ts
{
// Language code
language: string
// Bible version name
name: string
// Bible version description
description: string
// Bible books list
books: array<{
// Language code
book_number: number
// Book short name
short_name: string
// Book long name
long_name: string
// Total Chapters
chapters: number
// Total verses
verses: number
}>
}>
}
```
**Examples**

`http://localhost:35907/books?language=en`

```
{
"language": "en",
"name": "ESV",
"description": "English Standard Version 2001, 2016",
"books": [
{
"book_number": 10,
"short_name": "Gen",
"long_name": "Genesis",
"chapters": 50,
"verses": 1533
},
{
"book_number": 20,
"short_name": "Exo",
"long_name": "Exodus",
"chapters": 40,
"verses": 1213
},
...
...
]
}
```

## Find

```HTTP
GET /find
```

Find and return verses.

**Query parameters**

| Param | Type | Description | Mandatory |
| :-------- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |---|
| language | `String` | Language Code (ex. en, pt, it, ...) | Yes |
| search | `String` | Search String in format : [**book short name***].[**chapter**]:[**from verse**]-[**to verse**]

Examples :
Ge.1:2-3 - Genesis chapter 1 from verses 2 to 3
Le.4 : Leviticus chapter 4
Ru - All Ruth | Yes |
| version | `String` | Bible Version Name | No |

**Response**
```ts
{
// Language code
language: string
// Bible version name
name: string
// Bible version description
description: string
// Bible books list
books: array<{
// Language code
book_number: number
// Book short name
short_name: string
// Book long name
long_name: string
// Chapters list
chapters: array<{
// Chapter number
chapter_number: number
// Verses List
verses: array<{
// Verse Number
verse: number
// Verse Text
text: string
}>
}>
}>
}>
}
```
**Examples**

`http://localhost:35907/find?language=it&search=Ge.9:4-5;Le.10;Ru`

```
{
"language": "it",
"name": "NR94",
"description": "Nuova Riveduta 1994",
"books": [
{
"book_number": 10,
"short_name": "Ge",
"long_name": "Genesi",
"chapters": [
{
"chapter": 9,
"verses": [
{
"verse": 4,
"text": "ma non mangerete carne con la sua vita [1], cioè con il suo sangue."
},
{
"verse": 5,
"text": "Certo, io chiederò conto del vostro sangue, del sangue delle vostre vite; ne chiederò conto a ogni animale; chiederò conto della vita dell'uomo alla mano dell'uomo, alla mano di ogni suo fratello."
}
]
}
]
},
{
"book_number": 30,
"short_name": "Le",
"long_name": "Levitico",
"chapters": [
{
"chapter": 10,
"verses": [
{
"verse": 1,
"text": "ⓐ Nadab [1] e Abiu [2] figli d'Aaronne, presero ciascuno il suo turibolo, vi misero dentro del fuoco, vi posero sopra dell'incenso, e offrirono davanti al Signore del fuoco estraneo, diverso da ciò che egli aveva loro ordinato."
},
...
...
```

## Random

```HTTP
GET /random
```

Return a random verse.

**Query parameters**

| Param | Type | Description | Mandatory |
| :-------- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |---|
| language | `String` | Language Code (ex. en, pt, it, ...) | Yes |
| version | `String` | Bible Version Name | No |
| book | `String` | Bible Book Short Name (ex. Le, pr, ...) | No |

**Response**
```ts
{
// Language code
language: string
// Bible version name
name: string
// Bible version description
description: string
// Books List
books: array<{
// Language code
book_number: number
// Book short name
short_name: string
// Book long name
long_name: string
// Chapters list
chapters: array<{
// Chapter number
chapter_number: number
// Verses List
verses: array<{
// Verse Number
verse: number
// Verse Text
text: string
}>
}>
}>
}>
}
```
**Examples**

`http://localhost:35907/random?language=es&book=pr`

```
{
"language": "es",
"name": "RVA15",
"description": "Reina Valera Actualizada, 2015",
"books": [
{
"book_number": 240,
"short_name": "Pr",
"long_name": "Proverbios",
"chapters": [
{
"chapter": 15,
"verses": [
{
"verse": 10,
"text": "La disciplina le parece mal al que abandona el camino, y el que aborrece la reprensión morirá."
}
]
}
]
}
]
}
```

## Search

```HTTP
GET /search
```

Return verses contains a word or a sentence.

**Query parameters**

| Param | Type | Description | Mandatory |
| :-------- | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |---|
| language | `String` | Language Code (ex. en, pt, it, ...) | Yes |
| word | `String` | Word or sentence to find | Yes |
| version | `String` | Bible Version Name | No |
| limit | `Number` | Maximum number of results | No |

**Response**
```ts
{
// Language code
language: string
// Bible version name
name: string
// Bible version description
description: string
// String to search
search: string
// Total Number of matches
total: number
// Limit Number of matches to show
limit: number
// Results List
searches: array<{
// Language code
book_number: number
// Book short name
short_name: string
// Book long name
long_name: string
// Chapter number
chapter: number
// Verse Number
verse: number
// Verse Text
text: string
}>
}>
}>
}
```
**Examples**

`http://localhost:35907/search?language=en&word=bread&limit=2`

```
{
"language": "en",
"name": "ESV",
"description": "English Standard Version 2001, 2016",
"search": "bread",
"total": 376,
"limit": 2,
"searches": [
{
"book_number": 10,
"short_name": "Gen",
"long_name": "Genesis",
"chapter": 3,
"verse": 19,
"text": "By the sweat of your face you shall eat bread, till you return to the ground, for out of it you were taken; ⓤfor you are dust, and ⓥto dust you shall return.” "
},
{
"book_number": 10,
"short_name": "Gen",
"long_name": "Genesis",
"chapter": 6,
"verse": 15,
"text": "This is how you are to make it: the length of the ark 300 cubits, [5] its breadth 50 cubits, and its height 30 cubits."
}
]
}
```

## Error Managment

**Error Response**
```ts
{
// Language code
error: number,
function: string,
description: string
}
```

### Prerequisites

* Node v16.13.1 or upper
* npm v7.19.1 or upper

### Built With
* [Visual Code Editor](https://code.visualstudio.com)

### NPM Modules
npm install

### Run
npm start

### Authors

* **Giovanni Palleschi** - [gpalleschi](https://github.com/gpalleschi)

### License

This project is licensed under the GNU GENERAL PUBLIC LICENSE 3.0 License - see the [LICENSE](LICENSE) file for details

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/gpalleschi/holybible_api

Awesome Lists containing this project

README