0.1.0 • Published 7 years ago

apibible v0.1.0

Weekly downloads
-
License
Unlicense
Repository
-
Last release
7 years ago

apibible

Apibible - JavaScript client for apibible No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

  • API version: 0.1.0
  • Package version: 0.1.0
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install apibible --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var Apibible = require('apibible');

var api = new Apibible.BiblesApi()

var apiKey = "apiKey_example"; // {String} API Key Authentication Parameter

var bibleId = "bibleId_example"; // {String} Id of Bible to be fetched

api.getBible(apiKey, bibleId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://api.scripture.api.bible

ClassMethodHTTP requestDescription
Apibible.BiblesApigetBibleGET /v1/bibles/{bibleId}
Apibible.BiblesApigetBiblesGET /v1/bibles
Apibible.BooksApigetBookGET /v1/bibles/{bibleId}/books/{bookId}
Apibible.BooksApigetBooksGET /v1/bibles/{bibleId}/books
Apibible.ChaptersApigetChapterGET /v1/bibles/{bibleId}/chapters/{chapterId}
Apibible.ChaptersApigetChaptersGET /v1/bibles/{bibleId}/books/{bookId}/chapters
Apibible.PassagesApigetPassageGET /v1/bibles/{bibleId}/passages/{passageId}
Apibible.SectionsApigetBookSectionsGET /v1/bibles/{bibleId}/books/{bookId}/sections
Apibible.SectionsApigetChapterSectionsGET /v1/bibles/{bibleId}/chapters/{chapterId}/sections
Apibible.SectionsApigetSectionGET /v1/bibles/{bibleId}/sections/{sectionId}
Apibible.VersesApigetVerseGET /v1/bibles/{bibleId}/verses/{verseId}
Apibible.VersesApigetVersesGET /v1/bibles/{bibleId}/chapters/{chapterId}/verses
Apibible.VersesApisearchBibleGET /v1/bibles/{bibleId}/verses/search

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.