跳至主要內容

Markdown文档模板配置


Markdown文档模板配置

版本要求: 2023.2.2+

提供了导出文档和Api在线文档的自定义格式实现.

实现技术

  1. Velocityopen in new window
  2. Markdown

内置变量

内容变量

变量参数类型说明
urlString最终url
originUrlString原始url,包含路径原值变量名
namingPolicyString命名策略,固定值[1.byMethodName:根据方法名 2.byDoc:根据JavaDoc或者Swagger方法描述]
methodNameStringJava方法名
methodDescriptionString方法描述,来源javadoc或者Swagger方法描述
methodTypeString方法类型,例如Get,Post,Put,Delete,Patch
headerListList<Header>头参数
pathKeyValueListList<KeyValue>Url路径参数
urlParamsKeyValueListList<KeyValue>Url Query参数
multipartKeyValueListList<KeyValue>Multipart参数
urlEncodedKeyValueListList<KeyValue>Form Url-Encoded参数
jsonParamStringJson参数
jsonParamDocumentStringJson参数文档
responseExampleString响应
returnDocumentString响应参数文档

语法变量

变量说明
H1Markdown #
H2Markdown ##
H3Markdown ###
H4Markdown ####
H5Markdown #####
H6Markdown ######

参数类型

变量参数类型说明
enabledBoolean是否启用
typeStringHeader的key值
valueStringHeader的value值

KeyValue

变量参数类型说明
enabledBoolean是否启用
keyString参数Key
typeString参数类型,固定格式[Object Array String Number Boolean]
valueObject参数Value
commentString参数备注

默认模板

    #if (${namingPolicy}=='byDoc')
    $H1 ${methodDescription}
    #else
    $H1 $!{methodName}
    
    $H3 Method description
    
    ```
    $!{methodDescription}
    ```
    #end
    
    > URL: $!{url}
    >
    > Origin Url: $!{originUrl}
    >
    > Type: $!{methodType}
    
    
    $H3 Request headers
    
    |Header Name| Header Value|
    |---------|------|
    #foreach( $h in ${headerList})
    |$h.type|$h.value|
    #end
    
    $H3 Parameters
    
    $H5 Path parameters
    
    | Parameter | Type | Value | Description |
    |---------|------|------|------------|
    #foreach( $node in ${pathKeyValueList})
    |$node.key|$!{node.type}|$!{node.value}|$!{node.comment}|
    #end
    
    
    $H5 URL parameters
    
    |Required| Parameter | Type | Value | Description |
    |---------|---------|------|------|------------|
    #foreach( $node in ${urlParamsKeyValueList})
    |$!{node.enabled}|$!{node.key}|$!{node.type}|$!{node.value}|$!{node.comment}|
    #end
    
    
    $H5 Body parameters
    
    $H6 JSON
    
    ```
    ${jsonParam}
    ```
    
    $H6 JSON document
    
    ```
    ${jsonParamDocument}
    ```
    
    
    $H5 Form URL-Encoded
    |Required| Parameter | Type | Value | Description |
    |---------|---------|------|------|------------|
    #foreach( $node in ${urlEncodedKeyValueList})
    |$!{node.enabled}|$!{node.key}|$!{node.type}|$!{node.value}|$!{node.comment}|
    #end
    
    
    $H5 Multipart
    |Required | Parameter | Type | Value | Description |
    |---------|---------|------|------|------------|
    #foreach( $node in ${multipartKeyValueList})
    |$!{node.enabled}|$!{node.key}|$!{node.type}|$!{node.value}|$!{node.comment}|
    #end
    
    
    $H3 Response
    
    $H5 Response example
    
    ```
    $!{responseExample}
    ```
    
    $H5 Response document
    ```
    $!{returnDocument}
    ```