design_review_app_gateway
v1.0.1
Published
Design_Review_App_Gateway
Downloads
3
Readme
design_review_app_gateway
DesignReviewAppGateway - JavaScript client for design_review_app_gateway Design Review App Gateway 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.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 design_review_app_gateway --save
git
If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/design_review_app_gateway then install it via:
npm install YOUR_USERNAME/design_review_app_gateway --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.
Getting Started
Please follow the installation instruction and execute the following JS code:
var DesignReviewAppGateway = require('design_review_app_gateway');
var api = new DesignReviewAppGateway.PartManagementApi()
var sessionId = "sessionId_example"; // {String} The unique identifier of one session.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.partsGet(sessionId, callback);
Documentation for API Endpoints
All URIs are relative to http://localhost/v1
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- DesignReviewAppGateway.PartManagementApi | partsGet | GET /parts | DesignReviewAppGateway.PartManagementApi | partsPartIdGet | GET /parts/{partId} | DesignReviewAppGateway.PartManagementApi | partsRecentGet | GET /parts/recent | DesignReviewAppGateway.SessionManagementApi | usersLoginPost | POST /users/login | DesignReviewAppGateway.SessionManagementApi | usersLogoutPost | POST /users/logout | DesignReviewAppGateway.SessionManagementApi | usersRegisterPut | PUT /users/register | DesignReviewAppGateway.SimulationManagementApi | simPartIdGet | GET /sim/{partId} |
Documentation for Models
- DesignReviewAppGateway.IPart
- DesignReviewAppGateway.IPartAttribute
- DesignReviewAppGateway.IPartMetadata
- DesignReviewAppGateway.IPartSimData
- DesignReviewAppGateway.IServiceData
- DesignReviewAppGateway.ISession
- DesignReviewAppGateway.IUser
Documentation for Authorization
All endpoints do not require authorization.