node.js - Apdoc - Node.js 不显示@apiName

Question

我的 API 文档有问题。我想制作文档，但@apiName没有出现...我尝试添加@appVersion，但没有成功。

这是我的文档

/**
 * @api {post} /createBook
 * @apiGroup Books
 * @apiName CreateBook
 * @apiHeaderExample {json} Header-Example:
 *     {
 *       "Authorization": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7InVzZXIiOjV9LCJpYXQiOjE1NTA3NzI0MjEsImV4cCI6MTU1MDg1ODgyMX0.2xQyS6PrBIH3mZS2qTmrMemXxVSTHNhdxCgl_4qY3pU"
 *     }
 * @apiParam {String} name something
 * @apiParam {String} yearOfRelease something
 * @apiParam {String} condition something
 * @apiParam {String} price something
 * @apiParam {String} images something
 * @apiSuccessExample {json} CreateBook-Success-Response : HTTP/1.1 2000k
 * {
 *  'status': 'Added',
 *  'description': 'Book was added'
 * }
 */

这是我的代码......有人解决这个问题吗？谢谢

Answer 1

它用于命名和导航名称。

<ul class="sidenav nav nav-list">
<li class="nav-fixed nav-header" data-group="_">
<li class="nav-header" data-group="User">
<li data-version="0.3.0" data-name="GetUser" data-group="User">
<a href="#api-User-GetUser">Read data of a User</a>
</li>

稍后该名称应用于内联链接（尚未实现）。

我必须更新文档，更改 apiName 并且现在是可选的。该名称是从类型和路径自动生成的：@api {type} /path/ -> 如果未设置 apiName，则内部自动生成此 @apiName TypePath。

通过github https://github.com/apidoc/apidoc/issues/259

Answer 2

我以这种方式实现了它：

/**
 * @api {get} /alerts/param? Get target alerts by target action ids
 * @apiGroup ALERT
 * @apiName Alert Information
 *
 *

图片

你可以试试这个：

/**
 * @api {post} /createBook Create a new Book
 * @apiGroup Books
 * @apiName CreateBook
 .....