openapi-generator/samples/client/petstore-security-test/javascript

open_api_petstore____end____rn_n_r

OpenApiPetstoreEndRnNR - JavaScript client for open_api_petstore____end____rn_n_r This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: " \ *_/ ' " =end --
This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0 *_/ ' " =end -- \r\n \n \r
• Package version: 1.0.0 *_/ =end -- \r\n \n \r
• 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 open_api_petstore____end____rn_n_r --save

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

Finally, switch to the directory you want to use your open_api_petstore____end____rn_n_r from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('open_api_petstore____end____rn_n_r') in javascript files from the directory you ran the last command above from.

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, that's to say your javascript file where you actually use this library):

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 OpenApiPetstoreEndRnNR = require('open_api_petstore____end____rn_n_r');

var api = new OpenApiPetstoreEndRnNR.FakeApi()
var opts = {
  'UNKNOWN_BASE_TYPE': new OpenApiPetstoreEndRnNR.UNKNOWN_BASE_TYPE() // {UNKNOWN_BASE_TYPE} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.testCodeInjectEndRnNR(opts, callback);

Documentation for API Endpoints

All URIs are relative to *http://petstore.swagger.io / ' " =end -- \r\n \n \r/v2 */ ' " =end -- \r\n \n \r

Class	Method	HTTP request	Description
OpenApiPetstoreEndRnNR.FakeApi	testCodeInjectEndRnNR	PUT /fake	To test code injection *_/ ' " =end -- \r\n \n \r

Documentation for Models

• OpenApiPetstoreEndRnNR.ModelReturn

Documentation for Authorization

api_key

• Type: API key
• API key parameter name: api_key */ ' " =end -- \r\n \n \r
• Location: HTTP header

petstore_auth

• Type: OAuth
• Flow: implicit
• Authorization URL: http://petstore.swagger.io/api/oauth/dialog
• Scopes:
  • write:pets: modify pets in your account *_/ ' " =end -- \r\n \n \r
  • read:pets: read your pets *_/ ' " =end -- \r\n \n \r