1.0.1 • Published 10 months ago

openapilordoftheringssdk v1.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
10 months ago

Lord of the Rings SDK

The Lord of the Rings SDK is a JavaScript library that provides easy access to the movie and quote endpoints of the Lord of the Rings API.

Installation

npm install openapilordoftheringssdk

or

yarn add openapilordoftheringssdk

Usage

To use the Lord of the Rings SDK in your JavaScript project, import the library and create an instance of the LordOfTheRingsSDK class by passing your API key as a parameter:

const LordOfTheRingsSDK = require("openapilordoftheringssdk");

const apiKey = "YOUR_API_KEY";
const sdk = new LordOfTheRingsSDK(apiKey);

Get Movies To retrieve the list of movies from the Lord of the Rings API, use the getMovies method:

sdk
  .getMovies()
  .then((movies) => {
    console.log("Movies:", movies);
  })
  .catch((error) => {
    console.error("Error:", error);
  });

Get Movie by ID To get a specific movie by its ID, use the getMovieById method:

const movieId = "MOVIE_ID"; // Replace with an actual movie ID

sdk
  .getMovieById(movieId)
  .then((movie) => {
    console.log("Movie:", movie);
  })
  .catch((error) => {
    console.error("Error:", error);
  });

Get Movie Quotes To retrieve the quotes for a specific movie, use the getMovieQuotes method:

const movieId = "MOVIE_ID"; // Replace with an actual movie ID

sdk
  .getMovieQuotes(movieId)
  .then((quotes) => {
    console.log("Movie Quotes:", quotes);
  })
  .catch((error) => {
    console.error("Error:", error);
  });

Get Quotes To fetch all the quotes from the Lord of the Rings API, use the getQuotes method:

sdk
  .getQuotes()
  .then((quotes) => {
    console.log("Quotes:", quotes);
  })
  .catch((error) => {
    console.error("Error:", error);
  });

Get Quote by ID To retrieve a specific quote by its ID, use the getQuoteById method:

const quoteId = "QUOTE_ID"; // Replace with an actual quote ID

sdk
  .getQuoteById(quoteId)
  .then((quote) => {
    console.log("Quote:", quote);
  })
  .catch((error) => {
    console.error("Error:", error);
  });

Testing

To test the Lord of the Rings SDK, you can create a separate JavaScript file and use the provided code examples for different API requests. Replace the placeholders with actual values and run the script using Node.js. For example, create a test.js file and add the following code:

const LordOfTheRingsSDK = require("openapilordoftheringssdk");

const apiKey = "YOUR_API_KEY";
const sdk = new LordOfTheRingsSDK(apiKey);

sdk
  .getMovies()
  .then((movies) => {
    console.log("Movies:", movies);
  })
  .catch((error) => {
    console.error("Error:", error);
  });

Replace 'YOUR_API_KEY' with your actual API key. Save the file and run it using Node.js:

node test.js

You should see the output in the console, showing the fetched data from the Lord of the Rings API.

Feel free to test other methods provided by the SDK by following the usage examples described above.

That's it! You have successfully installed, used, and tested the Lord of the Rings SDK in your JavaScript project. Enjoy exploring the movie and quote data from the Lord of the Rings universe!

1.0.1

10 months ago

1.0.0

10 months ago