Kevin Locke df0c54d043 Support the empty string as an enumeration value (#4450)
When a string enumeration has the empty string as one of its available
values, the generated code for many languages is invalid because the
empty string can not be used as an identifier.  As with numbers and
symbols, provide a mapping to an English name which can be used as a
replacement.  In this case, "empty" for the empty string/empty value.

Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
2017-01-06 19:30:47 +08:00
..
2016-08-27 02:34:33 +03:00

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: class 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/v2

Class Method HTTP request Description
SwaggerPetstore.FakeApi testClientModel PATCH /fake To test &quot;client&quot; 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/{orderId} Delete purchase order by ID
SwaggerPetstore.StoreApi getInventory GET /store/inventory Returns pet inventories by status
SwaggerPetstore.StoreApi getOrderById GET /store/order/{orderId} 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

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