rkeplin/bible-php-api repository overview

⁠Bible PHP API

Bible PHP 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-php-api
cd bible-php-api && docker-compose up -d

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:8083⁠ for the REST API and http://localhost:8082⁠ for the UI (AngularJS).

⁠API Specifications

⁠List of available translations

GET http://localhost:8083/translations
GET http://localhost:8083/translations/[TranslationID]

⁠List of Genres

GET http://localhost:8083/genres
GET http://localhost:8083/genres/[GenreID]

⁠Content

GET http://localhost:8083/books
GET http://localhost:8083/books/[BookID]
GET http://localhost:8083/books/[BookID]/chapters/[ChapterID]
GET http://localhost:8083/books/[BookID]/chapters/[ChapterID]
GET http://localhost:8083/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:8083/books/1/chapters/1/1001002?translation=ASV

⁠Cross References

GET http://localhost:8083/verse/[VerseID]/relations 

⁠Running The Test Suite

docker-compose exec php-api sh -c "cd tests && /usr/local/bin/phpunit"

⁠Related Projects

• Bible Go API⁠
• Bible PHP API⁠
• Bible AngularJS UI⁠
• Bible MariaDB Docker Image⁠

⁠Credits

Data for this application was gathered from the following repositories.

• scrollmaper/bible_database⁠
• honza/bibles⁠