cloudwpss23_openapi_cyan

Cloudwpss23OpenapiCyan - JavaScript client for cloudwpss23_openapi_cyan OpenAPI Reference für das CloudWP der HAW Hamburg für das SommerSemster 2023 This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Package version: 1.0
• 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 cloudwpss23_openapi_cyan --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 cloudwpss23_openapi_cyan 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/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 Cloudwpss23OpenapiCyan = require('cloudwpss23_openapi_cyan');

var defaultClient = Cloudwpss23OpenapiCyan.ApiClient.instance;
// Configure OAuth2 access token for authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.accessToken = "YOUR ACCESS TOKEN"

var api = new Cloudwpss23OpenapiCyan.DefaultApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getApiExternal(callback);

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
Cloudwpss23OpenapiCyan.DefaultApi	getApiExternal	GET /api/external	Your GET endpoint
Cloudwpss23OpenapiCyan.DefaultApi	getUsersUserId	GET /users/{userId}	Get User Info by User ID
Cloudwpss23OpenapiCyan.DefaultApi	optionsApiExternal	OPTIONS /api/external
Cloudwpss23OpenapiCyan.DefaultApi	patchUsersUserId	PATCH /users/{userId}	Update User Information
Cloudwpss23OpenapiCyan.DefaultApi	postUser	POST /user	Create New User

Documentation for Models

• Cloudwpss23OpenapiCyan.GetApiExternal200Response
• Cloudwpss23OpenapiCyan.PatchUsersUserIdRequest
• Cloudwpss23OpenapiCyan.PostUserRequest
• Cloudwpss23OpenapiCyan.User

Documentation for Authorization

bearer

• Type: OAuth
• Flow: accessCode
• Authorization URL:
• Scopes: N/A