Skip to content

Certurix/aston-api

Repository files navigation

aston_api

AstonApi - JavaScript client for aston_api API principale de la communauté d'Aston This SDK is automatically generated by the Swagger Codegen project:

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

Installation

npm

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

Then install it via:

npm install aston_api --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 AstonApi = require('aston_api');

var api = new AstonApi.UserApi()
var userId = 1.2; // {Number} The id that needs to be fetched.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserbyUserId(userId, callback);

Documentation for API Endpoints

All URIs are relative to https://api.aston-rp.fr/api/v1

Class Method HTTP request Description
AstonApi.UserApi getUserbyUserId GET /user/{userId} Get user data by user id
AstonApi.UserApi updateUser PUT /user/{userId} Update userId

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published