concrete.templates.jaxrs.services.doc.gitbook.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

<#escape x as x?html> 
# ${module.label}

* **模块名称：** ${module.name}
* **模块定义：** ${module.interfaceClass.name}
<#if module.domain?? >* **角色领域：** ${module.domain.value()}

${module.description!""}

## 接口
<#list module.units?sort_by("label") as unit>
### <#if unit.deprecated>~~<#if unit.label?length == 0>根接口<#else>${unit.label}<#if unit.deprecated>~~

${unit.description!""}


* **method name:** ${unit.method.name}<#if unit.signable??>
* **sign:** ${tool.formatSignable(unit.signable)}<#assign paramCount=unit.parameters?size>
* **path:** ${module.name}${unit.name}
* **Http Method:** ${unit.invokeType}
* **acl:** <#if unit.accessAllow??><#list unit.roles as role>${role} <#else><#if module.domain?? >${module.domain.value()}.ANY<#else>Anonymous
* **return:** ${tool.formatTypeStr(unit.genericReturnType, module.interfaceClass)}
* **params:** <#if (paramCount > 0)>

| ParamName | Method | Label | Type                  | Description |
| --------- | -- | ---- | --------------------- | ------------ |<#list unit.parameters as param>
| <#if !param.assembled >-<#else>${param.name} | <#if !param.pathParam>${unit.invokeType} | ${param.label} | ${tool.formatTypeStr(param.genericType, module.interfaceClass)} | ${tool.tableSafe(param.description)} |<#else>NONE

<#if genResultJson?default(true)><#noescape>${tool.mockResult(unit)}