vidmob-soa-petstore

VidmobSoaPetstore - JavaScript client for vidmob-soa-petstore This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about Swagger at http://swagger.io. In the third iteration of the pet store, we've switched to the design first approach! You can now help us improve the API whether it's by making changes to the definition itself or to the code. That way, with time, we can improve the API in general, and expose some of the new features in OAS3.

Some useful links:

• The Pet Store repository

• The source API definition for the Pet Store This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.17

• Package version: 1.0.17

• 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 vidmob-soa-petstore --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 vidmob-soa-petstore 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 VidmobSoaPetstore = require('vidmob-soa-petstore');

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

var api = new VidmobSoaPetstore.PetApi()
var pet = new VidmobSoaPetstore.Pet(); // {Pet} Create a new pet in the store
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addPet(pet, callback);

Documentation for API Endpoints

All URIs are relative to https://petstore3.swagger.io/api/v3

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- VidmobSoaPetstore.PetApi | addPet | POST /pet | Add a new pet to the store VidmobSoaPetstore.PetApi | deletePet | DELETE /pet/{petId} | Deletes a pet VidmobSoaPetstore.PetApi | findPetsByStatus | GET /pet/findByStatus | Finds Pets by status VidmobSoaPetstore.PetApi | findPetsByTags | GET /pet/findByTags | Finds Pets by tags VidmobSoaPetstore.PetApi | getPetById | GET /pet/{petId} | Find pet by ID VidmobSoaPetstore.PetApi | updatePet | PUT /pet | Update an existing pet VidmobSoaPetstore.PetApi | updatePetWithForm | POST /pet/{petId} | Updates a pet in the store with form data VidmobSoaPetstore.PetApi | uploadFile | POST /pet/{petId}/uploadImage | uploads an image VidmobSoaPetstore.StoreApi | deleteOrder | DELETE /store/order/{orderId} | Delete purchase order by ID VidmobSoaPetstore.StoreApi | getInventory | GET /store/inventory | Returns pet inventories by status VidmobSoaPetstore.StoreApi | getOrderById | GET /store/order/{orderId} | Find purchase order by ID VidmobSoaPetstore.StoreApi | placeOrder | POST /store/order | Place an order for a pet VidmobSoaPetstore.UserApi | createUser | POST /user | Create user VidmobSoaPetstore.UserApi | createUsersWithListInput | POST /user/createWithList | Creates list of users with given input array VidmobSoaPetstore.UserApi | deleteUser | DELETE /user/{username} | Delete user VidmobSoaPetstore.UserApi | getUserByName | GET /user/{username} | Get user by user name VidmobSoaPetstore.UserApi | loginUser | GET /user/login | Logs user into the system VidmobSoaPetstore.UserApi | logoutUser | GET /user/logout | Logs out current logged in user session VidmobSoaPetstore.UserApi | updateUser | PUT /user/{username} | Update user

Documentation for Models

• VidmobSoaPetstore.Address
• VidmobSoaPetstore.ApiResponse
• VidmobSoaPetstore.Category
• VidmobSoaPetstore.Customer
• VidmobSoaPetstore.Order
• VidmobSoaPetstore.Pet
• VidmobSoaPetstore.Tag
• VidmobSoaPetstore.User

Documentation for Authorization

petstore_auth

• Type: OAuth
• Flow: implicit
• Authorization URL: https://petstore3.swagger.io/oauth/authorize
• Scopes:
  • write:pets: modify pets in your account
  • read:pets: read your pets

api_key

• Type: API key
• API key parameter name: api_key
• Location: HTTP header