forked from loafle/openapi-generator-original
Swift5 API client for PetstoreClient
This is a sample server Petstore server. For this sample, you can use the api key special-key to test the authorization filters.
Overview
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
- API version: 1.0.0
- Package version:
- Build package: org.openapitools.codegen.languages.Swift5ClientCodegen
Installation
Carthage
Run carthage update
CocoaPods
Run pod install
Documentation for API Endpoints
All URIs are relative to http://petstore.swagger.io/v2
| Class | Method | HTTP request | Description |
|---|---|---|---|
| PetAPI | addPet | POST /pet | Add a new pet to the store |
| PetAPI | deletePet | DELETE /pet/{petId} | Deletes a pet |
| PetAPI | findPetsByStatus | GET /pet/findByStatus | Finds Pets by status |
| PetAPI | findPetsByTags | GET /pet/findByTags | Finds Pets by tags |
| PetAPI | getPetById | GET /pet/{petId} | Find pet by ID |
| PetAPI | updatePet | PUT /pet | Update an existing pet |
| PetAPI | updatePetWithForm | POST /pet/{petId} | Updates a pet in the store with form data |
| PetAPI | uploadFile | POST /pet/{petId}/uploadImage | uploads an image |
| StoreAPI | deleteOrder | DELETE /store/order/{orderId} | Delete purchase order by ID |
| StoreAPI | getInventory | GET /store/inventory | Returns pet inventories by status |
| StoreAPI | getOrderById | GET /store/order/{orderId} | Find purchase order by ID |
| StoreAPI | placeOrder | POST /store/order | Place an order for a pet |
| UserAPI | createUser | POST /user | Create user |
| UserAPI | createUsersWithArrayInput | POST /user/createWithArray | Creates list of users with given input array |
| UserAPI | createUsersWithListInput | POST /user/createWithList | Creates list of users with given input array |
| UserAPI | deleteUser | DELETE /user/{username} | Delete user |
| UserAPI | getUserByName | GET /user/{username} | Get user by user name |
| UserAPI | loginUser | GET /user/login | Logs user into the system |
| UserAPI | logoutUser | GET /user/logout | Logs out current logged in user session |
| 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
auth_cookie
- Type: API key
- API key parameter name: AUTH_KEY
- Location:
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