tag_n_go_api v0.0.1
tag_n_go_api
TagNGoApi - JavaScript client for tag_n_go_api Tag-n-Go API allows to use Tag-n-Go services. This SDK is automatically generated by the Swagger Codegen project:
- API version: 0.0.1
- Package version: 0.0.1
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit https://twitter.com/tyomo4ka
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 tag_n_go_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 TagNGoApi = require('tag_n_go_api');
var api = new TagNGoApi.ProjectApi()
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.projectsGet(callback);
Documentation for API Endpoints
All URIs are relative to http://localhost:5000
Class | Method | HTTP request | Description |
---|---|---|---|
TagNGoApi.ProjectApi | projectsGet | GET /projects | Retrieves one or more projects |
TagNGoApi.ProjectApi | projectsPost | POST /projects | Stores one or more projects |
TagNGoApi.ProjectApi | projectsProjectIdDelete | DELETE /projects/{projectId} | Deletes a project document |
TagNGoApi.ProjectApi | projectsProjectIdGet | GET /projects/{projectId} | Retrieves a project document |
TagNGoApi.ProjectApi | projectsProjectIdPatch | PATCH /projects/{projectId} | Updates a project document |
TagNGoApi.ProjectApi | projectsProjectIdPut | PUT /projects/{projectId} | Replaces a project document |
TagNGoApi.UserApi | usersGet | GET /users | Retrieves one or more users |
TagNGoApi.UserApi | usersPost | POST /users | Stores one or more users |
TagNGoApi.UserApi | usersUserIdDelete | DELETE /users/{userId} | Deletes a user document |
TagNGoApi.UserApi | usersUserIdGet | GET /users/{userId} | Retrieves a user document |
TagNGoApi.UserApi | usersUserIdPatch | PATCH /users/{userId} | Updates a user document |
TagNGoApi.UserApi | usersUserIdPut | PUT /users/{userId} | Replaces a user document |
Documentation for Models
Documentation for Authorization
All endpoints do not require authorization.
8 years ago