api-doc - 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 }} 的调用（今天的模板中似乎是这种情况）