bibleapi / bibleapi-rest

Node.js based Bible API RESTful web service

Bible API REST

Bible API RESTful web service developed with Node.js

---

API

Single passage

Single verse

http://localhost:3333/api/Gen1:1

{
  verses: [
    {
      book: 1,
      chapter: 1,
      verse: 1,
      text: "In the beginning God created the heaven and the earth.",
      tran: "KJV",
      bookRef: "Gen",
      bookName: "Genesis"
    }
  ],
  text: "In the beginning God created the heaven and the earth."
}

Single chapter

http://localhost:3333/api/Gen1

Single passage range

Single verse range

http://localhost:3333/api/Gen1:1-5

Single chapter range

http://localhost:3333/api/Gen1-3

Single chapter and verses range

http://localhost:3333/api/Gen1:1-2:5

Multiple passages

http://localhost:3333/api/Gen1;Gen2:1-3:5

Supported translations

• KJV
• ASV

Single translation

http://localhost:3333/api/Gen1:1ASV

{
  verses: [
    {
      book: 1,
      chapter: 1,
      verse: 1,
      text: "In the beginning God created the heaven and the earth.",
      tran: "ASV",
      bookRef: "Gen",
      bookName: "Genesis"
    }
  ],
  text: "In the beginning God created the heaven and the earth."
}

Multiple translations

http://localhost:3333/api/Gen1:1KJV;ASV

{
  verses: [
    {
      book: 1,
      chapter: 1,
      verse: 1,
      text: "In the beginning God created the heaven and the earth.",
      tran: "KJV",
      bookRef: "Gen",
      bookName: "Genesis"
    },
    {
      book: 1,
      chapter: 1,
      verse: 1,
      text: "In the beginning God created the heavens and the earth.",
      tran: "ASV",
      bookRef: "Gen",
      bookName: "Genesis"
    }
  ]
}

Meta data

http://localhost:3333/api/meta/KJV

Development

Prerequisites

• MongoDB
• Node.js

Setup

Database

Import JSON files from this repo: https://github.com/dev4christ/usfm2json/tree/master/json

KJV

mongoimport --db bibleapi --collection bible --type json --file kjv.json

ASV

mongoimport --db bibleapi --collection bible --type json --file asv.json

NPM Modules

npm install

Run

gulp

Test

mocha

Demo

• http://bibleapi.ws/Gen1
• http://bibleapi.ws/Gen1:1

bibleapi-rest's Issues

Investigate why certain requests result in an error or incorrect response

Investigate why certain requests result in an error or incorrect response.

Request: http://localhost:4000/api/v1/Gen1-2
Response: message: "Bible passage is not found."

Request: http://localhost:4000/api/v1/Gen1-3
Response: Chapters 1 and 3 are missing!

Request: http://localhost:4000/api/v1/Gen1-4
Response: Chapters 1 and 4 are missing!

Please, develop tests to catch this kind of problems.

Add RST (Russian Synodal Translation) Bible version

Add RST (Russian Synodal Translation) Bible version to the project.

Add supported Bible translations meta data

Add supported Bible translations meta data. At the moment KJV and ASV are supported.
So when requested http://localhost:4000/api/v1/meta/translations send the following response:

{
   translations: ['KJV', 'ASV']
}

Normalize versification of RST vs KJV

Normalize versification of RST vs KJV and other English versions.

See how it's done here:
openbibleinfo/Bible-Passage-Reference-Parser#19

Use reversify npm module?
https://www.npmjs.com/package/reversify

Update documentation to the latest API version 0.1.0

Update documentation to reflect the latest changes in API with version 0.1.0.

Domain broken

Add ASV translation to the project

1. Add ASV along with KJV translation to the project.
2. Test if both translation work individually as well as within a single request.
3. Develop unit tests

Fix verse range request when verses are in mixed order

Fix verse range request when verses are in mixed order. This is a really strange bug!

Run this request once:
http://localhost:4000/api/v1/Matt3:5-2
Response: verse 2

Run request again:
http://localhost:4000/api/v1/Matt3:5-2
Response: verse 5

I think the correct response in this case should be verse 5. So the logic is:
When the verse range is incorrect (first verse is bigger then the second) ignore the second and return just the first verse. So in the case about should be verse 5 only.