fix sample code

2016-04-01 15:10:42 +08:00 · 2016-04-01 15:10:42 +08:00 · a4e3b3b6e1
commit a4e3b3b6e1
parent ef1ca9f6df
4 changed files with 290 additions and 10 deletions
--- a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/ObjcClientCodegen.java
+++ b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/ObjcClientCodegen.java
@ -4,6 +4,7 @@ import io.swagger.codegen.CliOption;
 import io.swagger.codegen.CodegenConfig;
 import io.swagger.codegen.CodegenConstants;
 import io.swagger.codegen.CodegenOperation;
+import io.swagger.codegen.CodegenParameter;
 import io.swagger.codegen.CodegenProperty;
 import io.swagger.codegen.CodegenType;
 import io.swagger.codegen.DefaultCodegen;
@ -640,7 +641,7 @@ public class ObjcClientCodegen extends DefaultCodegen implements CodegenConfig {
            example = "'" + escapeText(example) + "'";
        } else if (!languageSpecificPrimitives.contains(type)) {
            // type is a model class, e.g. User
-            example = this.packageName + "." + type + "()";
+            example = this.podName+ "." + type + "()";
        } else {
            LOGGER.warn("Type " + type + " not handled properly in setParameterExampleValue");
        }
--- a/modules/swagger-codegen/src/main/resources/objc/README.mustache
+++ b/modules/swagger-codegen/src/main/resources/objc/README.mustache
@ -1,20 +1,128 @@
 # {{podName}}

+{{#appDescription}}
+{{{appDescription}}}
+{{/appDescription}}
+
+This ObjC package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: {{appVersion}}
+- Package version: {{artifactVersion}}
+- Build date: {{generatedDate}}
+- Build package: {{generatorClass}}
+{{#infoUrl}}
+For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
+{{/infoUrl}}
+
 ## Requirements

-The API client library requires ARC (Automatic Reference Counting) to be enabled in your Xcode project.
+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
+### Install from Github using [CocoaPods](https://cocoapods.org/)

-To install it, put the API client library in your project and then simply add the following line to your Podfile:
+Add the following to the Podfile:

 ```ruby
-pod "{{podName}}", :path => "/path/to/lib"
+pod '{{podName}}', :git => 'https://github.com/{{gitUserId}}/{{gitRepoId}}.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. ./vendor/{{podName}}) and then add the following to the Podfile:
+
+```ruby
+pod '{{podName}}', :path => './vendor/{{podName}}'
+```
+
+## Usage
+
+Import the following:
+```objc
+#import <{{podName}}/{{{classPrefix}}}ApiClient.h>
+#import <{{podName}}/{{{classPrefix}}}Configuration.h>
+// load models
+{{#models}}{{#model}}#import <{{podName}}/{{{classname}}}>
+{{/model}}{{/models}}
+// load API classes for accessing endpoints
+{{#apiInfo}}{{#apis}}#import <{{podName}}/{{{classname}}}>
+{{/apis}}{{/apiInfo}}
 ```

 ## Recommendation

-It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issue.
+It's recommended to create an instance of ApiClient per thread in a multi-threaded environment to avoid any potential issue.
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```objc
+
+{{#apiInfo}}{{#apis}}{{#-first}}{{#operations}}{{#operation}}{{#-first}}{{#hasAuthMethods}}{{#authMethods}}{{#isBasic}}
+// Configure HTTP basic authorization: {{{name}}}
+{{{invokerPackage}}}\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
+{{{invokerPackage}}}\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');{{/isBasic}}{{#isApiKey}}
+// Configure API key authorization: {{{name}}}
+{{{invokerPackage}}}\Configuration::getDefaultConfiguration()->setApiKey('{{{keyParamName}}}', 'YOUR_API_KEY');
+// Uncomment below to setup prefix (e.g. BEARER) for API key, if needed
+// {{{invokerPackage}}}\Configuration::getDefaultConfiguration()->setApiKeyPrefix('{{{keyParamName}}}', 'BEARER');{{/isApiKey}}{{#isOAuth}}
+// Configure OAuth2 access token for authorization: {{{name}}}
+{{{invokerPackage}}}\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');{{/isOAuth}}{{/authMethods}}
+{{/hasAuthMethods}}
+
+$api_instance = new {{invokerPackage}}\Api\{{classname}}();
+{{#allParams}}${{paramName}} = {{{example}}}; // {{{dataType}}} | {{{description}}}
+{{/allParams}}
+
+try {
+    {{#returnType}}$result = {{/returnType}}$api_instance->{{{operationId}}}({{#allParams}}${{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}});{{#returnType}}
+    print_r($result);{{/returnType}}
+} catch (Exception $e) {
+    echo 'Exception when calling {{classname}}->{{operationId}}: ', $e->getMessage(), "\n";
+}
+{{/-first}}{{/operation}}{{/operations}}{{/-first}}{{/apis}}{{/apiInfo}}
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *{{basePath}}*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}}
+{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
+
+## Documentation For Models
+
+{{#models}}{{#model}} - [{{{classname}}}]({{modelDocPath}}{{{classname}}}.md)
+{{/model}}{{/models}}
+
+## Documentation For Authorization
+
+{{^authMethods}} All endpoints do not require authorization.
+{{/authMethods}}{{#authMethods}}{{#last}} Authentication schemes defined for the API:{{/last}}{{/authMethods}}
+{{#authMethods}}## {{{name}}}
+
+{{#isApiKey}}- **Type**: API key
+- **API key parameter name**: {{{keyParamName}}}
+- **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}
+{{/isApiKey}}
+{{#isBasic}}- **Type**: HTTP basic authentication
+{{/isBasic}}
+{{#isOAuth}}- **Type**: OAuth
+- **Flow**: {{{flow}}}
+- **Authorizatoin URL**: {{{authorizationUrl}}}
+- **Scopes**: {{^scopes}}N/A{{/scopes}}
+{{#scopes}} - **{{{scope}}}**: {{{description}}}
+{{/scopes}}
+{{/isOAuth}}
+
+{{/authMethods}}

 ## Author

--- a/samples/client/petstore/objc/README.md
+++ b/samples/client/petstore/objc/README.md
@ -1,20 +1,188 @@
 # SwaggerClient

+This is a sample server Petstore server.  You can find out more about Swagger at <a href=\"http://swagger.io\">http://swagger.io</a> or on irc.freenode.net, #swagger.  For this sample, you can use the api key \"special-key\" to test the authorization filters
+
+This ObjC package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: 1.0.0
+- Package version: 
+- Build date: 2016-04-01T12:02:50.753+08:00
+- Build package: class io.swagger.codegen.languages.ObjcClientCodegen
+
 ## Requirements

-The API client library requires ARC (Automatic Reference Counting) to be enabled in your Xcode project.
+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
+### Install from Github using [CocoaPods](https://cocoapods.org/)

-To install it, put the API client library in your project and then simply add the following line to your Podfile:
+Add the following to the Podfile:

 ```ruby
-pod "SwaggerClient", :path => "/path/to/lib"
+pod 'SwaggerClient', :git => 'https://github.com/YOUR_GIT_USR_ID/YOUR_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. ./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/SWGConfiguration.h>
+// load models
+#import <SwaggerClient/SWG200Response>
+#import <SwaggerClient/SWGAnimal>
+#import <SwaggerClient/SWGCat>
+#import <SwaggerClient/SWGCategory>
+#import <SwaggerClient/SWGDog>
+#import <SwaggerClient/SWGInlineResponse200>
+#import <SwaggerClient/SWGName>
+#import <SwaggerClient/SWGOrder>
+#import <SwaggerClient/SWGPet>
+#import <SwaggerClient/SWGReturn>
+#import <SwaggerClient/SWGSpecialModelName_>
+#import <SwaggerClient/SWGTag>
+#import <SwaggerClient/SWGUser>
+
+// load API classes for accessing endpoints
+#import <SwaggerClient/SWGPetApi>
+#import <SwaggerClient/SWGStoreApi>
+#import <SwaggerClient/SWGUserApi>
+
 ```

 ## Recommendation

-It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issue.
+It's recommended to create an instance of ApiClient per thread in a multi-threaded environment to avoid any potential issue.
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```objc
+
+
+// Configure OAuth2 access token for authorization: petstore_auth
+\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
+
+$api_instance = new \Api\SWGPetApi();
+$body = SwaggerClient.SWGPet*(); // SWGPet* | Pet object that needs to be added to the store
+
+try {
+    $api_instance->addPet($body);
+} catch (Exception $e) {
+    echo 'Exception when calling SWGPetApi->addPet: ', $e->getMessage(), "\n";
+}
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://petstore.swagger.io/v2*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*SWGPetApi* | [**addPet**](docs/SWGPetApi.md#addpet) | **POST** /pet | Add a new pet to the store
+*SWGPetApi* | [**addPetUsingByteArray**](docs/SWGPetApi.md#addpetusingbytearray) | **POST** /pet?testing_byte_array=true | Fake endpoint to test byte array in body parameter for adding a new pet to the store
+*SWGPetApi* | [**deletePet**](docs/SWGPetApi.md#deletepet) | **DELETE** /pet/{petId} | Deletes a pet
+*SWGPetApi* | [**findPetsByStatus**](docs/SWGPetApi.md#findpetsbystatus) | **GET** /pet/findByStatus | Finds Pets by status
+*SWGPetApi* | [**findPetsByTags**](docs/SWGPetApi.md#findpetsbytags) | **GET** /pet/findByTags | Finds Pets by tags
+*SWGPetApi* | [**getPetById**](docs/SWGPetApi.md#getpetbyid) | **GET** /pet/{petId} | Find pet by ID
+*SWGPetApi* | [**getPetByIdInObject**](docs/SWGPetApi.md#getpetbyidinobject) | **GET** /pet/{petId}?response=inline_arbitrary_object | Fake endpoint to test inline arbitrary object return by &#39;Find pet by ID&#39;
+*SWGPetApi* | [**petPetIdtestingByteArraytrueGet**](docs/SWGPetApi.md#petpetidtestingbytearraytrueget) | **GET** /pet/{petId}?testing_byte_array=true | Fake endpoint to test byte array return by &#39;Find pet by ID&#39;
+*SWGPetApi* | [**updatePet**](docs/SWGPetApi.md#updatepet) | **PUT** /pet | Update an existing pet
+*SWGPetApi* | [**updatePetWithForm**](docs/SWGPetApi.md#updatepetwithform) | **POST** /pet/{petId} | Updates a pet in the store with form data
+*SWGPetApi* | [**uploadFile**](docs/SWGPetApi.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image
+*SWGStoreApi* | [**deleteOrder**](docs/SWGStoreApi.md#deleteorder) | **DELETE** /store/order/{orderId} | Delete purchase order by ID
+*SWGStoreApi* | [**findOrdersByStatus**](docs/SWGStoreApi.md#findordersbystatus) | **GET** /store/findByStatus | Finds orders by status
+*SWGStoreApi* | [**getInventory**](docs/SWGStoreApi.md#getinventory) | **GET** /store/inventory | Returns pet inventories by status
+*SWGStoreApi* | [**getInventoryInObject**](docs/SWGStoreApi.md#getinventoryinobject) | **GET** /store/inventory?response=arbitrary_object | Fake endpoint to test arbitrary object return by &#39;Get inventory&#39;
+*SWGStoreApi* | [**getOrderById**](docs/SWGStoreApi.md#getorderbyid) | **GET** /store/order/{orderId} | Find purchase order by ID
+*SWGStoreApi* | [**placeOrder**](docs/SWGStoreApi.md#placeorder) | **POST** /store/order | Place an order for a pet
+*SWGUserApi* | [**createUser**](docs/SWGUserApi.md#createuser) | **POST** /user | Create user
+*SWGUserApi* | [**createUsersWithArrayInput**](docs/SWGUserApi.md#createuserswitharrayinput) | **POST** /user/createWithArray | Creates list of users with given input array
+*SWGUserApi* | [**createUsersWithListInput**](docs/SWGUserApi.md#createuserswithlistinput) | **POST** /user/createWithList | Creates list of users with given input array
+*SWGUserApi* | [**deleteUser**](docs/SWGUserApi.md#deleteuser) | **DELETE** /user/{username} | Delete user
+*SWGUserApi* | [**getUserByName**](docs/SWGUserApi.md#getuserbyname) | **GET** /user/{username} | Get user by user name
+*SWGUserApi* | [**loginUser**](docs/SWGUserApi.md#loginuser) | **GET** /user/login | Logs user into the system
+*SWGUserApi* | [**logoutUser**](docs/SWGUserApi.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session
+*SWGUserApi* | [**updateUser**](docs/SWGUserApi.md#updateuser) | **PUT** /user/{username} | Updated user
+
+
+## Documentation For Models
+
+ - [SWG200Response](docs/SWG200Response.md)
+ - [SWGAnimal](docs/SWGAnimal.md)
+ - [SWGCat](docs/SWGCat.md)
+ - [SWGCategory](docs/SWGCategory.md)
+ - [SWGDog](docs/SWGDog.md)
+ - [SWGInlineResponse200](docs/SWGInlineResponse200.md)
+ - [SWGName](docs/SWGName.md)
+ - [SWGOrder](docs/SWGOrder.md)
+ - [SWGPet](docs/SWGPet.md)
+ - [SWGReturn](docs/SWGReturn.md)
+ - [SWGSpecialModelName_](docs/SWGSpecialModelName_.md)
+ - [SWGTag](docs/SWGTag.md)
+ - [SWGUser](docs/SWGUser.md)
+
+
+## Documentation For Authorization
+
+
+## test_api_key_header
+
+- **Type**: API key
+- **API key parameter name**: test_api_key_header
+- **Location**: HTTP header
+
+## api_key
+
+- **Type**: API key
+- **API key parameter name**: api_key
+- **Location**: HTTP header
+
+## test_http_basic
+
+- **Type**: HTTP basic authentication
+
+## test_api_client_secret
+
+- **Type**: API key
+- **API key parameter name**: x-test_api_client_secret
+- **Location**: HTTP header
+
+## test_api_client_id
+
+- **Type**: API key
+- **API key parameter name**: x-test_api_client_id
+- **Location**: HTTP header
+
+## test_api_key_query
+
+- **Type**: API key
+- **API key parameter name**: test_api_key_query
+- **Location**: URL query string
+
+## petstore_auth
+
+- **Type**: OAuth
+- **Flow**: implicit
+- **Authorizatoin URL**: http://petstore.swagger.io/api/oauth/dialog
+- **Scopes**: 
+ - **write:pets**: modify pets in your account
+ - **read:pets**: read your pets
+

 ## Author

--- a/samples/client/petstore/objc/SwaggerClient/SWGApiClient.h
+++ b/samples/client/petstore/objc/SwaggerClient/SWGApiClient.h
@ -13,7 +13,10 @@
 */

 #import "SWG200Response.h"
+#import "SWGAnimal.h"
+#import "SWGCat.h"
 #import "SWGCategory.h"
+#import "SWGDog.h"
 #import "SWGInlineResponse200.h"
 #import "SWGName.h"
 #import "SWGOrder.h"
@ -81,7 +84,7 @@ extern NSString *const SWGResponseObjectErrorKey;
 +(bool) getOfflineState;

 /**
- * Sets the client reachability, this may be override by the reachability manager if reachability changes
+ * Sets the client reachability, this may be overridden by the reachability manager if reachability changes
 *
 * @param The client reachability.
 */