star_wars_api__swapi

StarWarsApiSwapi - JavaScript client for star_wars_api__swapi API documentation for SWAPI This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install star_wars_api__swapi --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var StarWarsApiSwapi = require('star_wars_api__swapi');

var api = new StarWarsApiSwapi.DefaultApi()
var id = 1.2; // {Number} The ID of the character to retrieve

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiCharactersIdFilmsGet(id, callback);

Documentation for API Endpoints

All URIs are relative to /

Class	Method	HTTP request	Description
StarWarsApiSwapi.DefaultApi	apiCharactersIdFilmsGet	GET /api/characters/{id}/films	Get a list of films for a specfic characters id.
StarWarsApiSwapi.DefaultApi	apiFilmsIdCharactersGet	GET /api/films/{id}/characters	Get a list of characters for a specfic film id.
StarWarsApiSwapi.DefaultApi	apiFilmsIdPlanetsGet	GET /api/films/{id}/planets	Get a list of planets for a specfic film id.
StarWarsApiSwapi.DefaultApi	apiFilmsIdSpeciesGet	GET /api/films/{id}/species	Get a list of species for a specfic film id.
StarWarsApiSwapi.DefaultApi	apiFilmsIdStarshipsGet	GET /api/films/{id}/starships	Get a list of starships for a specfic film id.
StarWarsApiSwapi.DefaultApi	apiFilmsIdVehiclesGet	GET /api/films/{id}/vehicles	Get a list of vehicles for a specfic film id.
StarWarsApiSwapi.DefaultApi	apiPlanetsIdCharactersGet	GET /api/planets/{id}/characters	Get a list of characters for a specfic planet id.
StarWarsApiSwapi.DefaultApi	apiPlanetsIdFilmsGet	GET /api/planets/{id}/films	Get a list of films for a specfic planet id.
StarWarsApiSwapi.DefaultApi	apiSpeciesIdCharactersGet	GET /api/species/{id}/characters	Get a list of characters for a specfic species id.
StarWarsApiSwapi.DefaultApi	apiStarshipsIdCharactersGet	GET /api/starships/{id}/characters	Get a list of characters for a specfic starship id.

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.