smooth_api

SmoothApi - JavaScript client for smooth_api Smooth API This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.0.3
• Package version: 0.0.3
• Build package: org.openapitools.codegen.languages.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 smooth_api --save

Finally, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your smooth_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/YOUR_USERNAME/smooth_api then install it via:

    npm install YOUR_USERNAME/smooth_api --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 SmoothApi = require('smooth_api');


var api = new SmoothApi.ApiAppApi()
var opts = {
  'apiAppRequest': new SmoothApi.ApiAppRequest() // {ApiAppRequest} Created api app object
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createApiApp(opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:8000

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- SmoothApi.ApiAppApi | createApiApp | POST /apiApp | Create api app SmoothApi.ApiAppApi | createApiAppRelease | POST /apiApp/{app_id}/release | Create api app release SmoothApi.ApiAppApi | createApiAppReleaseSdks | POST /apiApp/{app_id}/release/{release_id}/sdk | Generate sdks for a relase SmoothApi.UserApi | createUser | POST /user | Create user SmoothApi.UserApi | updateUser | PUT /user/{user_id} | Update user

Documentation for Models

• SmoothApi.ApiApp
• SmoothApi.ApiAppRequest
• SmoothApi.Language
• SmoothApi.Logo
• SmoothApi.Release
• SmoothApi.ReleaseRequest
• SmoothApi.Sdk
• SmoothApi.SdkRequest
• SmoothApi.SdkResponse
• SmoothApi.Spec
• SmoothApi.User
• SmoothApi.UserPostRequest
• SmoothApi.UserPutRequest

Documentation for Authorization

bearerAuth

• Type: Bearer authentication (JWT)