openapi-generator-original/samples/client/petstore/objc/default/README.md

SwaggerClient

This is a sample server Petstore server. For this sample, you can use the api key "special-key" to test the authorization filters

This ObjC package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version:
• Build package: org.openapitools.codegen.languages.ObjcClientCodegen

Requirements

The SDK requires ARC (Automatic Reference Counting) to be enabled in the Xcode project.

Installation & Usage

Install from Github using CocoaPods

Add the following to the Podfile:

pod 'SwaggerClient', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

To specify a particular branch, append , :branch => 'branch-name-here'

To specify a particular commit, append , :commit => '11aa22'

Install from local path using CocoaPods

Put the SDK under your project folder (e.g. /path/to/objc_project/Vendor/SwaggerClient) and then add the following to the Podfile:

pod 'SwaggerClient', :path => 'Vendor/SwaggerClient'

Usage

Import the following:

#import <SwaggerClient/SWGApiClient.h>
#import <SwaggerClient/SWGDefaultConfiguration.h>
// load models
#import <SwaggerClient/SWGCategory.h>
#import <SwaggerClient/SWGOrder.h>
#import <SwaggerClient/SWGPet.h>
#import <SwaggerClient/SWGTag.h>
#import <SwaggerClient/SWGUser.h>
// load API classes for accessing endpoints
#import <SwaggerClient/SWGPetApi.h>
#import <SwaggerClient/SWGStoreApi.h>
#import <SwaggerClient/SWGUserApi.h>

Recommendation

It's recommended to create an instance of ApiClient per thread in a multi-threaded environment to avoid any potential issues.

Getting Started

Please follow the installation procedure and then run the following:

SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: petstore_auth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


SWGPet* *pet = [[SWGPet alloc] init]; // Pet object that needs to be added to the store (optional)

SWGPetApi *apiInstance = [[SWGPetApi alloc] init];

// Add a new pet to the store
[apiInstance addPetWithPet:pet
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
SWGPetApi	addPet	POST /pet	Add a new pet to the store
SWGPetApi	deletePet	DELETE /pet/{petId}	Deletes a pet
SWGPetApi	findPetsByStatus	GET /pet/findByStatus	Finds Pets by status
SWGPetApi	findPetsByTags	GET /pet/findByTags	Finds Pets by tags
SWGPetApi	getPetById	GET /pet/{petId}	Find pet by ID
SWGPetApi	updatePet	PUT /pet	Update an existing pet
SWGPetApi	updatePetWithForm	POST /pet/{petId}	Updates a pet in the store with form data
SWGPetApi	uploadFile	POST /pet/{petId}/uploadImage	uploads an image
SWGStoreApi	deleteOrder	DELETE /store/order/{orderId}	Delete purchase order by ID
SWGStoreApi	getInventory	GET /store/inventory	Returns pet inventories by status
SWGStoreApi	getOrderById	GET /store/order/{orderId}	Find purchase order by ID
SWGStoreApi	placeOrder	POST /store/order	Place an order for a pet
SWGUserApi	createUser	POST /user	Create user
SWGUserApi	createUsersWithArrayInput	POST /user/createWithArray	Creates list of users with given input array
SWGUserApi	createUsersWithListInput	POST /user/createWithList	Creates list of users with given input array
SWGUserApi	deleteUser	DELETE /user/{username}	Delete user
SWGUserApi	getUserByName	GET /user/{username}	Get user by user name
SWGUserApi	loginUser	GET /user/login	Logs user into the system
SWGUserApi	logoutUser	GET /user/logout	Logs out current logged in user session
SWGUserApi	updateUser	PUT /user/{username}	Updated user

Documentation For Models

• SWGCategory
• SWGOrder
• SWGPet
• SWGTag
• SWGUser

Documentation For Authorization

api_key

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

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

Author