forked from loafle/openapi-generator-original
153 lines
6.3 KiB
Markdown
153 lines
6.3 KiB
Markdown
# 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.
|
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
|
|
|
- API version: 1.0.0
|
|
- Package version: 1.0.0
|
|
- Build date: 2016-05-06T17:51:36.114+08:00
|
|
- Build package: class io.swagger.codegen.languages.JavascriptClientCodegen
|
|
|
|
## Installation
|
|
|
|
### For [Node.js](https://nodejs.org/)
|
|
|
|
#### npm
|
|
|
|
To publish the library as a [npm](https://www.npmjs.com/),
|
|
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
|
|
|
|
Then install it via:
|
|
|
|
```shell
|
|
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:
|
|
|
|
```shell
|
|
npm install GIT_USER_ID/GIT_REPO_ID --save
|
|
```
|
|
|
|
### For browser
|
|
|
|
The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):
|
|
|
|
```shell
|
|
browserify main.js > bundle.js
|
|
```
|
|
|
|
Then include *bundle.js* in the HTML pages.
|
|
|
|
## Getting Started
|
|
|
|
Please follow the [installation](#installation) instruction and execute the following JS code:
|
|
|
|
```javascript
|
|
var SwaggerPetstore = require('swagger-petstore');
|
|
|
|
var api = new SwaggerPetstore.FakeApi()
|
|
|
|
var _number = 3.4; // {Number} None
|
|
|
|
var _double = 1.2; // {Number} None
|
|
|
|
var _string = "_string_example"; // {String} None
|
|
|
|
var _byte = "B"; // {String} None
|
|
|
|
var opts = {
|
|
'integer': 56, // {Integer} None
|
|
'int32': 56, // {Integer} None
|
|
'int64': 789, // {Integer} None
|
|
'_float': 3.4, // {Number} None
|
|
'binary': "B", // {String} None
|
|
'_date': new Date("2013-10-20"), // {Date} None
|
|
'dateTime': new Date("2013-10-20T19:20:30+01:00"), // {Date} None
|
|
'password': "password_example" // {String} None
|
|
};
|
|
api.testEndpointParameters(_number, _double, _string, _byte, opts).then(function() {
|
|
console.log('API called successfully.');
|
|
}, 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* | [**testEndpointParameters**](docs/FakeApi.md#testEndpointParameters) | **POST** /fake | Fake endpoint for testing various parameters
|
|
*SwaggerPetstore.PetApi* | [**addPet**](docs/PetApi.md#addPet) | **POST** /pet | Add a new pet to the store
|
|
*SwaggerPetstore.PetApi* | [**deletePet**](docs/PetApi.md#deletePet) | **DELETE** /pet/{petId} | Deletes a pet
|
|
*SwaggerPetstore.PetApi* | [**findPetsByStatus**](docs/PetApi.md#findPetsByStatus) | **GET** /pet/findByStatus | Finds Pets by status
|
|
*SwaggerPetstore.PetApi* | [**findPetsByTags**](docs/PetApi.md#findPetsByTags) | **GET** /pet/findByTags | Finds Pets by tags
|
|
*SwaggerPetstore.PetApi* | [**getPetById**](docs/PetApi.md#getPetById) | **GET** /pet/{petId} | Find pet by ID
|
|
*SwaggerPetstore.PetApi* | [**updatePet**](docs/PetApi.md#updatePet) | **PUT** /pet | Update an existing pet
|
|
*SwaggerPetstore.PetApi* | [**updatePetWithForm**](docs/PetApi.md#updatePetWithForm) | **POST** /pet/{petId} | Updates a pet in the store with form data
|
|
*SwaggerPetstore.PetApi* | [**uploadFile**](docs/PetApi.md#uploadFile) | **POST** /pet/{petId}/uploadImage | uploads an image
|
|
*SwaggerPetstore.StoreApi* | [**deleteOrder**](docs/StoreApi.md#deleteOrder) | **DELETE** /store/order/{orderId} | Delete purchase order by ID
|
|
*SwaggerPetstore.StoreApi* | [**getInventory**](docs/StoreApi.md#getInventory) | **GET** /store/inventory | Returns pet inventories by status
|
|
*SwaggerPetstore.StoreApi* | [**getOrderById**](docs/StoreApi.md#getOrderById) | **GET** /store/order/{orderId} | Find purchase order by ID
|
|
*SwaggerPetstore.StoreApi* | [**placeOrder**](docs/StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet
|
|
*SwaggerPetstore.UserApi* | [**createUser**](docs/UserApi.md#createUser) | **POST** /user | Create user
|
|
*SwaggerPetstore.UserApi* | [**createUsersWithArrayInput**](docs/UserApi.md#createUsersWithArrayInput) | **POST** /user/createWithArray | Creates list of users with given input array
|
|
*SwaggerPetstore.UserApi* | [**createUsersWithListInput**](docs/UserApi.md#createUsersWithListInput) | **POST** /user/createWithList | Creates list of users with given input array
|
|
*SwaggerPetstore.UserApi* | [**deleteUser**](docs/UserApi.md#deleteUser) | **DELETE** /user/{username} | Delete user
|
|
*SwaggerPetstore.UserApi* | [**getUserByName**](docs/UserApi.md#getUserByName) | **GET** /user/{username} | Get user by user name
|
|
*SwaggerPetstore.UserApi* | [**loginUser**](docs/UserApi.md#loginUser) | **GET** /user/login | Logs user into the system
|
|
*SwaggerPetstore.UserApi* | [**logoutUser**](docs/UserApi.md#logoutUser) | **GET** /user/logout | Logs out current logged in user session
|
|
*SwaggerPetstore.UserApi* | [**updateUser**](docs/UserApi.md#updateUser) | **PUT** /user/{username} | Updated user
|
|
|
|
|
|
## Documentation for Models
|
|
|
|
- [SwaggerPetstore.Animal](docs/Animal.md)
|
|
- [SwaggerPetstore.AnimalFarm](docs/AnimalFarm.md)
|
|
- [SwaggerPetstore.ApiResponse](docs/ApiResponse.md)
|
|
- [SwaggerPetstore.Cat](docs/Cat.md)
|
|
- [SwaggerPetstore.Category](docs/Category.md)
|
|
- [SwaggerPetstore.Dog](docs/Dog.md)
|
|
- [SwaggerPetstore.EnumClass](docs/EnumClass.md)
|
|
- [SwaggerPetstore.EnumTest](docs/EnumTest.md)
|
|
- [SwaggerPetstore.FormatTest](docs/FormatTest.md)
|
|
- [SwaggerPetstore.Model200Response](docs/Model200Response.md)
|
|
- [SwaggerPetstore.ModelReturn](docs/ModelReturn.md)
|
|
- [SwaggerPetstore.Name](docs/Name.md)
|
|
- [SwaggerPetstore.Order](docs/Order.md)
|
|
- [SwaggerPetstore.Pet](docs/Pet.md)
|
|
- [SwaggerPetstore.SpecialModelName](docs/SpecialModelName.md)
|
|
- [SwaggerPetstore.Tag](docs/Tag.md)
|
|
- [SwaggerPetstore.User](docs/User.md)
|
|
|
|
|
|
## Documentation for Authorization
|
|
|
|
|
|
### 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
|
|
|
|
### api_key
|
|
|
|
- **Type**: API key
|
|
- **API key parameter name**: api_key
|
|
- **Location**: HTTP header
|
|
|