Ezekiel-saturday-sdk NPM

The One API SDK (TypeScript)

This SDK provides a convenient way to access the "The One API" (https://the-one-api.dev/v2/) movie endpoints in TypeScript. The SDK is built using functional components and axios library to make HTTP requests.

Installation

To install the The One API SDK, simply run the following command in your project directory:

npm install ezekiel-saturday-sdk

Usage

To use the SDK, simply import it into your file:

import TheOneApi from 'ezekiel-saturday-sdk';

You need an access token to make requests to the "The One API". You can obtain an access token by signing up for an account here. All you need for setting up an account is a valid email address.

You can then use the following methods to interact with the movie endpoints of the API:

async function main() {
  const theOneApi = TheOneApi({accessToken: "your-access-key"});

  const movies = await theOneApi.getMovies();
  console.log(movies.data);

  const movie = await theOneApi.getOneMovie('id');
  console.log(movie.data);

  const quotes = await theOneApi.getMovieQuotes('id');
  console.log(quotes.data);
}

main();

Testing

You can test the SDK by importing it into a test file and using the jest library to run tests against the API. Here is an example test file:

import theOneApi from 'ezekiel-saturday-sdk';

describe('The One API SDK', () => {
  it('should get all movies', async () => {
    const response = await theOneApi.getMovies();
    expect(response.status).toEqual(200);
  });

  it('should get a movie by id', async () => {
    const response = await theOneApi.getOneMovie('id');
    expect(response.status).toEqual(200);
  });

  it("should get movie's quotes", async () => {
    const response = await theOneApi.getMovieQuotes('id');
    expect(response.status).toEqual(200);
  });
});

You can then run the tests using the following command:

npm run test

Conclusion

With this SDK, you can easily access the movie endpoints of "The One API" in a project. The SDK is easy to install, use, and test, making it a convenient solution for any project that requires access to this API.

Contributing

We welcome contributions to the The One API SDK. If you find a bug or would like to make a feature request, please open an issue on the repository's issue tracker.