0.0.1 • Published 8 years ago

tag_n_go_api v0.0.1

Weekly downloads
5
License
Proprietary
Repository
-
Last release
8 years ago

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

ClassMethodHTTP requestDescription
TagNGoApi.ProjectApiprojectsGetGET /projectsRetrieves one or more projects
TagNGoApi.ProjectApiprojectsPostPOST /projectsStores one or more projects
TagNGoApi.ProjectApiprojectsProjectIdDeleteDELETE /projects/{projectId}Deletes a project document
TagNGoApi.ProjectApiprojectsProjectIdGetGET /projects/{projectId}Retrieves a project document
TagNGoApi.ProjectApiprojectsProjectIdPatchPATCH /projects/{projectId}Updates a project document
TagNGoApi.ProjectApiprojectsProjectIdPutPUT /projects/{projectId}Replaces a project document
TagNGoApi.UserApiusersGetGET /usersRetrieves one or more users
TagNGoApi.UserApiusersPostPOST /usersStores one or more users
TagNGoApi.UserApiusersUserIdDeleteDELETE /users/{userId}Deletes a user document
TagNGoApi.UserApiusersUserIdGetGET /users/{userId}Retrieves a user document
TagNGoApi.UserApiusersUserIdPatchPATCH /users/{userId}Updates a user document
TagNGoApi.UserApiusersUserIdPutPUT /users/{userId}Replaces a user document

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.