Sign inSign up

rkeplin/bible-go-api

By rkeplin

Updated 3 months ago

Image
0

2.0K

rkeplin/bible-go-api repository overview

Bible Go API

Build Status

Bible Go API is an open source REST API. It contains multiple translations of The Holy Bible, as well as cross-references. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY.

Live Demo

A live demo of this application can be viewed here.

Getting Everything Running
git clone https://www.github.com/rkeplin/bible-go-api
cd bible-go-api
make images
make up

Note: Upon first start, the volume containing the MySQL data may take several seconds to load.

You should then be able to access http://localhost:8084 for the REST API and http://localhost:8082 for the UI (AngularJS).

API Specifications
List of available translations
GET http://localhost:8084/translations
GET http://localhost:8084/translations/[TranslationID]
List of Genres
GET http://localhost:8084/genres
GET http://localhost:8084/genres/[GenreID]
Content
GET http://localhost:8084/books
GET http://localhost:8084/books/[BookID]
GET http://localhost:8084/books/[BookID]/chapters/[ChapterID]
GET http://localhost:8084/books/[BookID]/chapters/[ChapterID]
GET http://localhost:8084/books/[BookID]/chapters/[ChapterID]/[VerseID]

Note: In order to get content for a specific translation, supply translation as a Query Parameter. For example, http://localhost:8084/books/1/chapters/1/1001002?translation=ASV

Cross References
GET http://localhost:8084/verse/[VerseID]/relations 
GET http://localhost:8084/search?query=[Query]
Credits

Data for this application was gathered from the following repositories.

Tag summary

Content type

Image

Digest

sha256:54d55ed45

Size

33.1 MB

Last updated

3 months ago

docker pull rkeplin/bible-go-api