swagger_demo_api_doc
SwaggerDemoApiDoc - JavaScript client for swagger_demo_api_doc This is a restful api document of Swagger Demo. This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0
- Package version: 1.0
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
Installation
Node.js
Fornpm
To publish the library as a [npm]( , please follow the procedure in "Publishing npm packages".
Then install it via:
npm install swagger_demo_api_doc --save
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing
into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
Finally, switch to the directory you want to use your swagger_demo_api_doc from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('swagger_demo_api_doc')
in javascript files from the directory you ran the last
command above from.
git
If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/swagger_demo_api_doc then install it via:
npm install YOUR_USERNAME/swagger_demo_api_doc --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, that's to say your javascript file where you actually
use this library):
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 SwaggerDemoApiDoc = require('swagger_demo_api_doc');
var api = new SwaggerDemoApiDoc.BasicErrorControllerApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.errorUsingDELETE(callback);
Documentation for API Endpoints
All URIs are relative to https://localhost:8001
Class | Method | HTTP request | Description |
---|---|---|---|
SwaggerDemoApiDoc.BasicErrorControllerApi | errorUsingDELETE | DELETE /error | error |
SwaggerDemoApiDoc.BasicErrorControllerApi | errorUsingGET | GET /error | error |
SwaggerDemoApiDoc.BasicErrorControllerApi | errorUsingHEAD | HEAD /error | error |
SwaggerDemoApiDoc.BasicErrorControllerApi | errorUsingOPTIONS | OPTIONS /error | error |
SwaggerDemoApiDoc.BasicErrorControllerApi | errorUsingPATCH | PATCH /error | error |
SwaggerDemoApiDoc.BasicErrorControllerApi | errorUsingPOST | POST /error | error |
SwaggerDemoApiDoc.BasicErrorControllerApi | errorUsingPUT | PUT /error | error |
SwaggerDemoApiDoc.UserControllerApi | deleteUsingDELETE | DELETE /user/delete/{id} | delete of method |
SwaggerDemoApiDoc.UserControllerApi | findUsingGET | GET /user/find/{id} | find of method |
SwaggerDemoApiDoc.UserControllerApi | saveUsingPOST | POST /user/save | save of method |
Documentation for Models
Documentation for Authorization
All endpoints do not require authorization.