APIDocJS - 使用方法类型和@apiName而不是描述

Question

当我生成API文档时，索引页左侧的每个API的链接当前都是从API的描述中生成的。

@api {post} /my/endpoint **this is the current link name**

我希望链接名称是方法类型（在上面的示例 post 中）和@apiName的组合。对于这个块评论：

@api {post} /my/endpoint description of API
@apiName Create Cake

我希望该API的链接文本为 POST - Create Cake

有没有这样做？

Answer 1

通过复制模板/文件夹，您可以使用自己的模板；参见http://apidocjs.com/#template

要实现的目标，请在index.html的第一段中添加

<span class="method">{{ type }}</span>

并在style.css中添加一条规则：

.method { text-transform: uppercase }

您还可以将对{{title}}的呼叫更改为对{{name}}的呼叫（今天的模板中似乎是这种情况）