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

它用于命名和导航名称。

const videoRequest = fetch("/path/to/video.mp4")
    .then(response => response.blob());

videoRequest.then(blob => {
    video.src = window.URL.createObjectURL(blob);
});

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

我必须更新文档，更改apiName，现在是可选的。该名称是从und类型的路径自动生成的：@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
 *
 *

Image

您可以尝试以下操作：

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

Apidoc-Node.js不向我显示@apiName

2 个答案: