concrete.templates.jaxrs.jquery.doc.v1.module.md Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of concrete-api-tools Show documentation

There is a newer version: 0.5.3-RC1


# ${module.label}

## 获得模块
<#assign insName=tool.camelCase(module.interfaceClass.simpleName)>
```javascript
var ${insName} = concrete.module(getName);
```
${module.description!""}

## 接口
<#list module.units as unit>
### <#if unit.deprecated>~~${unit.method.name}<#if unit.deprecated>~~

${unit.description!""}

```javascript
// example
${insName}.${unit.method.name}(${tool.mockParameters(unit, module)}).success(function(data) {
  // do something ..
});
```
<#escape x as x?html> 
<#assign paramCount=unit.parameters?size>
* **return:** ${tool.formatTypeStr(unit.genericReturnType, module.interfaceClass)}
* **params:** <#if (paramCount > 0)>

| paramName | label | Type                  | description |
| --------- |---- | --------------------- | ------------ |<#list unit.parameters as param>
| ${param.name} | ${param.label} | ${tool.formatTypeStr(param.genericType, module.interfaceClass)} | ${tool.tableSafe(param.description)} |<#else>NONE