Code Monkey home page Code Monkey logo

swapi-wrapper's Introduction

Star Wars API Wrapper

A simple wrapper to the Star Wars API. Include the library and then make calls to the various API end points. Current methods are:

  • getResources - Returns a list of all available resources. Not really useful for this library.
  • getPerson(id) - Returns one person.
  • getPeople([page]) - Returns everyone, paged. Defaults to page 1.
  • getFilm(id) - Returns one film.
  • getFilms([page]) - Returns all films, paged. Defaults to page 1.
  • getPlanet(id) - Returns a planet.
  • getPlanets([page]) - Returns all plaents, paged. Defaults to page 1.
  • getSpecies(id) - Returns one species.
  • getAllSpecies([page]) - Returns all species, paged. Defaults to page 1.
  • getStarship(id) - Returns a starship.
  • getStarships([page]) - Returns all starships, paged. Defaults to page 1.
  • getVehicle(id) - Returns a vehicle.
  • getVehicles([page]) - Returns all vehicles, paged. Defaults to page 1.

Every method above takes a callback argument. Examples:

//get all vehicles
swapiModule.getVehicles(function(data) {
	console.log("Result of getVehicles", data);
});
//get all vehicles, page 2
swapiModule.getVehicles(2, function(data) {
	console.log("Result of getVehicles (page 2)", data);
});

//get one vehicle (assumes 4 works)
swapiModule.getVehicle(4,function(data) {
	console.log("Result of getVehicle/4", data);
});

To be done: I know I can optimize the code a bit. I'll do that. I also want to add a caching layer. Finally, it needs some proper unit tests.

History

Added unit tests and a grunt task. Also a minified version.

swapi-wrapper's People

Contributors

cfjedimaster avatar david-casagrande avatar joellanciaux avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.