@gitonga/sdk_test v1.0.4
Lord of the Rings SDK
Mellon , this is the one API (What the hell is an Application Programming Interface?) to rule them all . No really, it serves your needs regarding data about The Lord of the Rings , the epic books by J. R. R. Tolkien and the official movie adaptions by Peter Jackson.
There are many endpoints available, but you need to sign up to obtain an access key. Get a glimpse into the documentation to check out all accessible datasets.
Installation
NPM
To install via NPM:
npm install @gitonga/sdk_test --save
If you're using a bundler (like Rollup or webpack), you can import the Appwrite module when you need it:
import RingsSDK from "@gitonga/sdk_test";
Getting Started
Init your SDK
Initialize your SDK with your Appwrite server API endpoint and project ID which can be found in your project settings page.
// Init your Web SDK
const client: RingsSDK = new RingsSDK({
apiKey: "Your API Key",
});
Make Your Requests
Once your SDK object is set, access any of the SDK services and choose any request to send.
The request currently available are :
- get all the movies
${baseUrl}/movies
- get movie details
${baseUrl}/movies/$${id}
- get movie quotes
${baseUrl}/movies/$${id}/quote
- get all the quotes
${baseUrl}/quote
- get a qoute details
${baseUrl}/quote/$${id}
//Get all the quotes
client.getQoutes().then((p: any) => {
console.log(p);
});
// Get a quote by id
client.getQuoteById("testId").then((p: any) => {
console.log(p);
});
// Get all the movies
client.getMovies().then((p: any) => {
console.log(p);
});
// Get Movie Detail by Id
client.getMovieById("testid").then((p: any) => {
console.log(p);
});
// Get movie quotes
client.getMovieQuotes("testid").then((p: any) => {
console.log(p);
});
Full Example
// Init your Web SDK
//import the package
import RingsSDK from "@gitonga/sdk_test";
// Init your Web SDK
const client: RingsSDK = new RingsSDK({
apiKey: "testAPIKey",
});
client.getQoutes().then((p: any) => {
console.log(p);
});
Learn more
You can use the following resources to learn more and get help
License
MIT