npm.io
1.0.3 • Published 7 years ago

gjv-dev-example-api-client

Licence
Unlicense
Version
1.0.3
Deps
2
Size
131 kB
Vulns
0
Weekly
0
DeprecatedThis package is deprecated

gjv-dev-example-api-client

GjvDevExampleApiClient - JavaScript client for gjv-dev-example-api-client No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.3
  • Build package: org.openapitools.codegen.languages.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 gjv-dev-example-api-client --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 GjvDevExampleApiClient = require('gjv-dev-example-api-client');


var api = new GjvDevExampleApiClient.FullstrideGameControllerApi()
var opts = {
  'where': null // {Object} 
};
api.fullstrideGameControllerCount(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://gjv-dev-fullstride-api.herokuapp.com

Class Method HTTP request Description
GjvDevExampleApiClient.FullstrideGameControllerApi fullstrideGameControllerCount GET /fullstride-games/count
GjvDevExampleApiClient.FullstrideGameControllerApi fullstrideGameControllerCreate POST /fullstride-games
GjvDevExampleApiClient.FullstrideGameControllerApi fullstrideGameControllerDeleteById DELETE /fullstride-games/{id}
GjvDevExampleApiClient.FullstrideGameControllerApi fullstrideGameControllerFind GET /fullstride-games
GjvDevExampleApiClient.FullstrideGameControllerApi fullstrideGameControllerFindById GET /fullstride-games/{id}
GjvDevExampleApiClient.FullstrideGameControllerApi fullstrideGameControllerReplaceById PUT /fullstride-games/{id}
GjvDevExampleApiClient.FullstrideGameControllerApi fullstrideGameControllerUpdateAll PATCH /fullstride-games
GjvDevExampleApiClient.FullstrideGameControllerApi fullstrideGameControllerUpdateById PATCH /fullstride-games/{id}
GjvDevExampleApiClient.PingControllerApi pingControllerPing GET /ping

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.