openapi-generator/samples/client/petstore/javascript-promise-es6/README.md

swagger_petstore

SwaggerPetstore - JavaScript client for swagger_petstore This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: " \ This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.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 swagger_petstore --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.

Getting Started

Please follow the installation instruction and execute the following JS code:

var SwaggerPetstore = require('swagger_petstore');

var api = new SwaggerPetstore.FakeApi()

var body = new SwaggerPetstore.Client(); // {Client} client model

api.testClientModel(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://petstore.swagger.io:80/v2

Class	Method	HTTP request	Description
SwaggerPetstore.FakeApi	testClientModel	PATCH /fake	To test "client" model
SwaggerPetstore.FakeApi	testEndpointParameters	POST /fake	Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
SwaggerPetstore.FakeApi	testEnumParameters	GET /fake	To test enum parameters
SwaggerPetstore.PetApi	addPet	POST /pet	Add a new pet to the store
SwaggerPetstore.PetApi	deletePet	DELETE /pet/{petId}	Deletes a pet
SwaggerPetstore.PetApi	findPetsByStatus	GET /pet/findByStatus	Finds Pets by status
SwaggerPetstore.PetApi	findPetsByTags	GET /pet/findByTags	Finds Pets by tags
SwaggerPetstore.PetApi	getPetById	GET /pet/{petId}	Find pet by ID
SwaggerPetstore.PetApi	updatePet	PUT /pet	Update an existing pet
SwaggerPetstore.PetApi	updatePetWithForm	POST /pet/{petId}	Updates a pet in the store with form data
SwaggerPetstore.PetApi	uploadFile	POST /pet/{petId}/uploadImage	uploads an image
SwaggerPetstore.StoreApi	deleteOrder	DELETE /store/order/{order_id}	Delete purchase order by ID
SwaggerPetstore.StoreApi	getInventory	GET /store/inventory	Returns pet inventories by status
SwaggerPetstore.StoreApi	getOrderById	GET /store/order/{order_id}	Find purchase order by ID
SwaggerPetstore.StoreApi	placeOrder	POST /store/order	Place an order for a pet
SwaggerPetstore.UserApi	createUser	POST /user	Create user
SwaggerPetstore.UserApi	createUsersWithArrayInput	POST /user/createWithArray	Creates list of users with given input array
SwaggerPetstore.UserApi	createUsersWithListInput	POST /user/createWithList	Creates list of users with given input array
SwaggerPetstore.UserApi	deleteUser	DELETE /user/{username}	Delete user
SwaggerPetstore.UserApi	getUserByName	GET /user/{username}	Get user by user name
SwaggerPetstore.UserApi	loginUser	GET /user/login	Logs user into the system
SwaggerPetstore.UserApi	logoutUser	GET /user/logout	Logs out current logged in user session
SwaggerPetstore.UserApi	updateUser	PUT /user/{username}	Updated user

Documentation for Models

• SwaggerPetstore.AdditionalPropertiesClass
• SwaggerPetstore.Animal
• SwaggerPetstore.AnimalFarm
• SwaggerPetstore.ApiResponse
• SwaggerPetstore.ArrayOfArrayOfNumberOnly
• SwaggerPetstore.ArrayOfNumberOnly
• SwaggerPetstore.ArrayTest
• SwaggerPetstore.Capitalization
• SwaggerPetstore.Cat
• SwaggerPetstore.Category
• SwaggerPetstore.ClassModel
• SwaggerPetstore.Client
• SwaggerPetstore.Dog
• SwaggerPetstore.EnumArrays
• SwaggerPetstore.EnumClass
• SwaggerPetstore.EnumTest
• SwaggerPetstore.FormatTest
• SwaggerPetstore.HasOnlyReadOnly
• SwaggerPetstore.List
• SwaggerPetstore.MapTest
• SwaggerPetstore.MixedPropertiesAndAdditionalPropertiesClass
• SwaggerPetstore.Model200Response
• SwaggerPetstore.ModelReturn
• SwaggerPetstore.Name
• SwaggerPetstore.NumberOnly
• SwaggerPetstore.Order
• SwaggerPetstore.OuterEnum
• SwaggerPetstore.Pet
• SwaggerPetstore.ReadOnlyFirst
• SwaggerPetstore.SpecialModelName
• SwaggerPetstore.Tag
• SwaggerPetstore.User

Documentation for Authorization

api_key

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

http_basic_test

• Type: HTTP basic authentication

petstore_auth

• Type: OAuth
• Flow: implicit
• Authorization URL: http://petstore.swagger.io/api/oauth/dialog
• Scopes:
  • write:pets: modify pets in your account
  • read:pets: read your pets