template.ApiDoc.btl Maven / Gradle / Ivy

Go to download

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

ApplicationPower api-doc

There is a newer version: 0.5


# ${desc}
<%
for(doc in list){
%>
## ${doc.desc}
**URL:** ${doc.url}

**Type:** ${doc.type}

**Content-Type:** ${doc.contentType}

<%if(isNotEmpty(doc.headers)){%>
**Request-headers:**

Name | Type|Description
---|---|---
${doc.headers}
<%}%>

<%if(isNotEmpty(doc.requestParams)){%>
**Request-parameters:**

Parameter | Type|Description|Required
---|---|---|---
${doc.requestParams}
<%}%>

<%if(isNotEmpty(doc.requestUsage)){%>
**Request-example:**
```
${doc.requestUsage}
```
<%}%>
<%if(isNotEmpty(doc.responseParams)){%>
**Response-fields:**

Field | Type|Description
---|---|---
${doc.responseParams}
<%}%>

<%if(isNotEmpty(doc.responseUsage)){%>
**Response-example:**
```
${doc.responseUsage}
```
<%}%>

<% } %>