SDK for LOTR API

Installation

npm install antonbochkarev-sdk / yarn add antonbochkarev-sdk

Functionality

Create new instance of SDK API with your API key from https://the-one-api.dev/. API key will be used in methods where required. Then you can use methods from instanse of this class.

| API route | Function | Usage | Response | | --- | --- | --- | --- | | /book | package_import_name.getAllBooks() | | List of all "The Lord of the Rings" books | | /book/:id | package_import_name.getOneBook(id: string) | ID required | Request one specific book | | /book/:id/chapter | package_import_name.getOneBookChapters(id: string) | ID required | Request all chapters of one specific book | | /movie | package_import_name.getAllMovies() | | List of all movies, including the "The Lord of the Rings" and the "The Hobbit" trilogies | | /movie/:id | package_import_name.getOneMovie(id: string) | ID required. | Request one specific movie | | /movie/:id/quote | package_import_name.getAllMovies() | ID required. | Request all movie quotes for one specific movie (only working for the LotR trilogy) | | /character | package_import_name.getAllCharacters() | | List of characters including metadata like name, gender, realm, race and more | | /character/:id | package_import_name.getOneCharacter(id: string) | ID required. | Request one specific character | | /character/:id/quote | package_import_name.getOneCharacterQuotes(id: string) | ID required. | Request all movie quotes of one specific character | | /quote | package_import_name.getAllQuotes() | | List of all movie quotes | | /quote/:id | package_import_name.getOneQuote(id: string) | ID required. | Request one specific movie quote | | /chapter | package_import_name.getAllChapters() | | List of all book chapters | | /chapter/:id | package_import_name.getOneChapter() | ID required. | Request one specific book chapter |

Testing

For testing you should clone this repo, run npm install, then run API_KEY=__your_API_key__ npm test. There are five test suites, one for each entity.