cats_example_samxiao v1.0.0
cats_example
CatsExample - JavaScript client for cats_example The cats API description This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0
- Package version: 1.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 cats_example --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 CatsExample = require('cats_example');
var api = new CatsExample.DefaultApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.appControllerGetHello(callback);
Documentation for API Endpoints
All URIs are relative to /
Class | Method | HTTP request | Description |
---|---|---|---|
CatsExample.DefaultApi | appControllerGetHello | GET / | |
CatsExample.DefaultApi | demoControllerCreate | POST /demo | |
CatsExample.DefaultApi | demoControllerFindAll | GET /demo | |
CatsExample.DefaultApi | demoControllerFindOne | GET /demo/{id} | |
CatsExample.DefaultApi | demoControllerRemove | DELETE /demo/{id} | |
CatsExample.DefaultApi | demoControllerUpdate | PATCH /demo/{id} |
Documentation for Models
Documentation for Authorization
All endpoints do not require authorization.
1 year ago