openapi-generator/samples/client/petstore/javascript/README.md
2017-10-20 22:16:41 +08:00

9.8 KiB

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
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 swagger_petstore from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('swagger_petstore') 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 SwaggerPetstore = require('swagger_petstore');

var api = new SwaggerPetstore.AnotherFakeApi()

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


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

Documentation for API Endpoints

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

Class Method HTTP request Description
SwaggerPetstore.AnotherFakeApi testSpecialTags PATCH /another-fake/dummy To test special tags
SwaggerPetstore.FakeApi fakeOuterBooleanSerialize POST /fake/outer/boolean
SwaggerPetstore.FakeApi fakeOuterCompositeSerialize POST /fake/outer/composite
SwaggerPetstore.FakeApi fakeOuterNumberSerialize POST /fake/outer/number
SwaggerPetstore.FakeApi fakeOuterStringSerialize POST /fake/outer/string
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.FakeApi testInlineAdditionalProperties POST /fake/inline-additionalProperties test inline additionalProperties
SwaggerPetstore.FakeApi testJsonFormData GET /fake/jsonFormData test json serialization of form data
SwaggerPetstore.FakeClassnameTags123Api testClassname PATCH /fake_classname_test To test class name in snake case
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

Documentation for Authorization

api_key

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

api_key_query

  • Type: API key
  • API key parameter name: api_key_query
  • Location: URL query string

http_basic_test

  • Type: HTTP basic authentication

petstore_auth