forked from loafle/openapi-generator-original
113 lines
3.4 KiB
Markdown
113 lines
3.4 KiB
Markdown
# SwaggerClient
|
|
|
|
This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ *_/ ' \" =end --
|
|
|
|
This ObjC package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
|
|
|
- API version: 1.0.0 *_/ ' \" =end -- \\r\\n \\n \\r
|
|
- Package version:
|
|
- Build package: io.swagger.codegen.languages.ObjcClientCodegen
|
|
|
|
## Requirements
|
|
|
|
The SDK requires [**ARC (Automatic Reference Counting)**](http://stackoverflow.com/questions/7778356/how-to-enable-disable-automatic-reference-counting) to be enabled in the Xcode project.
|
|
|
|
## Installation & Usage
|
|
### Install from Github using [CocoaPods](https://cocoapods.org/)
|
|
|
|
Add the following to the Podfile:
|
|
|
|
```ruby
|
|
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](https://cocoapods.org/)
|
|
|
|
Put the SDK under your project folder (e.g. /path/to/objc_project/Vendor/SwaggerClient) and then add the following to the Podfile:
|
|
|
|
```ruby
|
|
pod 'SwaggerClient', :path => 'Vendor/SwaggerClient'
|
|
```
|
|
|
|
### Usage
|
|
|
|
Import the following:
|
|
|
|
```objc
|
|
#import <SwaggerClient/SWGApiClient.h>
|
|
#import <SwaggerClient/SWGDefaultConfiguration.h>
|
|
// load models
|
|
#import <SwaggerClient/SWGReturn.h>
|
|
// load API classes for accessing endpoints
|
|
#import <SwaggerClient/SWGFakeApi.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](#installation--usage) and then run the following:
|
|
|
|
```objc
|
|
|
|
|
|
NSString* *testCodeInjectEndRnNR = @"testCodeInjectEndRnNR_example"; // To test code injection *_/ ' \" =end -- \\r\\n \\n \\r (optional)
|
|
|
|
SWGFakeApi *apiInstance = [[SWGFakeApi alloc] init];
|
|
|
|
// To test code injection *_/ ' \" =end -- \\r\\n \\n \\r
|
|
[apiInstance testCodeInjectEndRnNRWithTestCodeInjectEndRnNR:testCodeInjectEndRnNR
|
|
completionHandler: ^(NSError* error) {
|
|
if (error) {
|
|
NSLog(@"Error: %@", error);
|
|
}
|
|
}];
|
|
|
|
```
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *https://petstore.swagger.io *_/ ' \" =end -- \\r\\n \\n \\r/v2 *_/ ' \" =end -- \\r\\n \\n \\r*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*SWGFakeApi* | [**testCodeInjectEndRnNR**](docs/SWGFakeApi.md#testcodeinjectendrnnr) | **PUT** /fake | To test code injection *_/ ' \" =end -- \\r\\n \\n \\r
|
|
|
|
|
|
## Documentation For Models
|
|
|
|
- [SWGReturn](docs/SWGReturn.md)
|
|
|
|
|
|
## Documentation For Authorization
|
|
|
|
|
|
## api_key
|
|
|
|
- **Type**: API key
|
|
- **API key parameter name**: api_key */ ' " =end -- \r\n \n \r
|
|
- **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 *_/ ' \" =end -- \\r\\n \\n \\r
|
|
- **read:pets**: read your pets *_/ ' \" =end -- \\r\\n \\n \\r
|
|
|
|
|
|
## Author
|
|
|
|
apiteam@swagger.io *_/ ' \" =end -- \\r\\n \\n \\r
|
|
|
|
|