-
-
Notifications
You must be signed in to change notification settings - Fork 6.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add auto-generated doc to Swift4 generator (#2666)
* add auto-generated doc to swift4 generators * fix rxswift sample code * fix object initialize * fix boolean value * fix link to object * fix void * fix url initialize * update all swift samples * fix indentation
- Loading branch information
Showing
235 changed files
with
12,198 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
97 changes: 97 additions & 0 deletions
97
modules/openapi-generator/src/main/resources/swift4/api_doc.mustache
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| # {{classname}}{{#description}} | ||
| {{description}}{{/description}} | ||
|
|
||
| All URIs are relative to *{{{basePath}}}* | ||
|
|
||
| Method | HTTP request | Description | ||
| ------------- | ------------- | ------------- | ||
| {{#operations}}{{#operation}}[**{{operationId}}**]({{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}} | ||
| {{/operation}}{{/operations}} | ||
|
|
||
| {{#operations}} | ||
| {{#operation}} | ||
| # **{{{operationId}}}** | ||
| ```swift | ||
| {{^usePromiseKit}} | ||
| {{^useRxSwift}} | ||
| open class func {{operationId}}({{#allParams}}{{paramName}}: {{#isEnum}}{{#isContainer}}{{{dataType}}}{{/isContainer}}{{^isContainer}}{{{datatypeWithEnum}}}_{{operationId}}{{/isContainer}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{^required}}? = nil{{/required}}{{#hasMore}}, {{/hasMore}}{{/allParams}}{{#hasParams}}, {{/hasParams}}completion: @escaping (_ data: {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}?, _ error: Error?) -> Void) | ||
| {{/useRxSwift}} | ||
| {{/usePromiseKit}} | ||
| {{#usePromiseKit}} | ||
| open class func {{operationId}}({{#allParams}} {{paramName}}: {{#isEnum}}{{#isContainer}}{{{dataType}}}{{/isContainer}}{{^isContainer}}{{{datatypeWithEnum}}}_{{operationId}}{{/isContainer}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{^required}}? = nil{{/required}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) -> Promise<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> | ||
| {{/usePromiseKit}} | ||
| {{#useRxSwift}} | ||
| open class func {{operationId}}({{#allParams}}{{paramName}}: {{#isEnum}}{{#isContainer}}{{{dataType}}}{{/isContainer}}{{^isContainer}}{{{datatypeWithEnum}}}_{{operationId}}{{/isContainer}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{^required}}? = nil{{/required}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) -> Observable<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> | ||
| {{/useRxSwift}} | ||
| ``` | ||
|
|
||
| {{{summary}}}{{#notes}} | ||
|
|
||
| {{{notes}}}{{/notes}} | ||
|
|
||
| ### Example | ||
| ```swift | ||
| // The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new | ||
| import {{{projectName}}} | ||
|
|
||
| {{#allParams}}let {{paramName}} = {{{vendorExtensions.x-swift-example}}} // {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}} | ||
| {{/allParams}} | ||
|
|
||
| {{^usePromiseKit}} | ||
| {{^useRxSwift}} | ||
| {{#summary}} | ||
| // {{{.}}} | ||
| {{/summary}} | ||
| {{classname}}.{{{operationId}}}({{#allParams}}{{paramName}}: {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) { (response, error) in | ||
| guard error == nil else { | ||
| print(error) | ||
| return | ||
| } | ||
|
|
||
| if (response) { | ||
| dump(response) | ||
| } | ||
| } | ||
| {{/useRxSwift}} | ||
| {{/usePromiseKit}} | ||
| {{#usePromiseKit}} | ||
| {{#summary}} | ||
| // {{{.}}} | ||
| {{/summary}} | ||
| {{classname}}.{{{operationId}}}({{#allParams}}{{paramName}}: {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}).then { | ||
| // when the promise is fulfilled | ||
| }.always { | ||
| // regardless of whether the promise is fulfilled, or rejected | ||
| }.catch { errorType in | ||
| // when the promise is rejected | ||
| } | ||
| {{/usePromiseKit}} | ||
| {{#useRxSwift}} | ||
| // TODO RxSwift sample code not yet implemented. To contribute, please open a ticket via http://github.com/OpenAPITools/openapi-generator/issues/new | ||
| {{/useRxSwift}} | ||
| ``` | ||
|
|
||
| ### Parameters | ||
| {{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}} | ||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}} | ||
| {{#allParams}} **{{paramName}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{baseType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#defaultValue}}[default to {{defaultValue}}]{{/defaultValue}} | ||
| {{/allParams}} | ||
|
|
||
| ### Return type | ||
|
|
||
| {{#returnType}}{{#returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{{returnType}}}**]({{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}Void (empty response body){{/returnType}} | ||
|
|
||
| ### Authorization | ||
|
|
||
| {{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{{name}}}](../README.md#{{{name}}}){{^-last}}, {{/-last}}{{/authMethods}} | ||
|
|
||
| ### HTTP request headers | ||
|
|
||
| - **Content-Type**: {{#consumes}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/consumes}}{{^consumes}}Not defined{{/consumes}} | ||
| - **Accept**: {{#produces}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/produces}}{{^produces}}Not defined{{/produces}} | ||
|
|
||
| [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) | ||
|
|
||
| {{/operation}} | ||
| {{/operations}} |
11 changes: 11 additions & 0 deletions
11
modules/openapi-generator/src/main/resources/swift4/model_doc.mustache
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| {{#models}}{{#model}}# {{classname}} | ||
|
|
||
| ## Properties | ||
| Name | Type | Description | Notes | ||
| ------------ | ------------- | ------------- | ------------- | ||
| {{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{{dataType}}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{^isContainer}}[**{{dataType}}**]({{complexType}}.md){{/isContainer}}{{#isContainer}}{{{dataType}}}{{/isContainer}}{{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#readOnly}}[readonly] {{/readOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}} | ||
| {{/vars}} | ||
|
|
||
| [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) | ||
|
|
||
| {{/model}}{{/models}} |
Oops, something went wrong.