0.0.0 • Published 2 years ago

@jpcolling/swagger-js-client v0.0.0

Weekly downloads
-
License
Unlicense
Repository
-
Last release
2 years ago

swagger-js-client

SwaggerJsClient - JavaScript client for swagger-js-client No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

  • API version: 0.0.0
  • Package version: 0.0.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 swagger-js-client --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 SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.DefaultApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiDocJsonGet(callback);

Documentation for API Endpoints

All URIs are relative to /

ClassMethodHTTP requestDescription
SwaggerJsClient.DefaultApiapiDocJsonGetGET /api/doc.json
SwaggerJsClient.DefaultApideleteCompanyDELETE /api/companies/{company_id}
SwaggerJsClient.DefaultApideleteVendorDELETE /api/vendors/{vendor_id}
SwaggerJsClient.DefaultApigetCompaniesGET /api/companies
SwaggerJsClient.DefaultApigetCompanyGET /api/companies/{company_id}
SwaggerJsClient.DefaultApigetVendorGET /api/vendors/{vendor_id}
SwaggerJsClient.DefaultApigetVendorsGET /api/vendors
SwaggerJsClient.DefaultApipartiallyUpdateCompanyPATCH /api/companies/{company_id}
SwaggerJsClient.DefaultApipartiallyUpdateVendorPATCH /api/vendors/{vendor_id}
SwaggerJsClient.DefaultApipostNewCompanyPOST /api/companies
SwaggerJsClient.DefaultApipostNewVendorPOST /api/vendors
SwaggerJsClient.DefaultApiupdateCompanyPUT /api/companies/{company_id}
SwaggerJsClient.DefaultApiupdateVendorPUT /api/vendors/{vendor_id}

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.