api_method(route) ::= <<
<method_title(route)>
<route.operation.description>
<method_signature(route)>
<method_parameters(route)>
>>
method_title(route) ::= <<
[[javascript-<route.javascriptClassReferenceId>-<route.javascriptMethodReferenceId>]]
===== <route.javascriptClassShortName>.prototype.<route.javascriptMethodName>
>>
method_signature(route) ::= <<
.Method Signature
[source,javascript]
....
<route.javascriptClassShortName>.<route.javascriptMethodName>(<if(route.paramHelpers)><route.paramHelpers:{p | <p.name>}; separator=", ">, <endif>callback);
....
>>
method_parameters(route) ::= <<
.Parameters
[cols="1,1,2a,1", options="header"]
|===
| Name
| Type
| Description
| Required
<if(route.paramHelpers)><route.paramHelpers:method_parameter()><endif>
| callback
| `function(error, <route.successResponseJavascriptType>)`
| The second parameter: <route.successResponseJavascriptTypeRef>
| true
|===
>>
method_parameter(paramHelper) ::= <<
| <paramHelper.name>
| <paramHelper.javascriptTypeRef>
| <paramHelper.description>
| <paramHelper.required>
>>
method_response(route) ::= <<
.Returns
[cols="1,2a", options="header"]
|===
| Type
| Notes
| <route.successResponseJavascriptTypeRef>
| <route.successResponseDescription>
|===
>>
javascript_model(model) ::= <<
<model_title(model)>
<model.model.description>
<if(model.propertyHelpers)><model_properties(model)><endif>
>>
model_title(model) ::= <<
[[javascript-model-<model.idRef>]]
===== <model.id>
>>
model_properties(model) ::= <<
.Properties
[cols="1,1,3a", options="header"]
|===
| Type
| Name
| Description
<model.propertyHelpers:model_property()>
|===
>>
model_property(propertyHelper) ::= <<
| <propertyHelper.javascriptTypeRef>
| <propertyHelper.id>
| <propertyHelper.property.description>
>>
# |
Change |
User |
Description |
Committed |
|
#1
|
20014 |
Paul Allen |
Moved swagger gneration inside project. |
|
|
//guest/paul_allen/hws/dev/swagger/src/main/resources/asciidoc/javascript.stg |
#1
|
19966 |
Paul Allen |
Refactor... |
|
|