文章/答案/技术大牛

发布

社区首页 >问答首页 >Apidoc - Node.js没有显示@apiName

问Apidoc - Node.js没有显示@apiName
EN

Stack Overflow用户

提问于 2019-02-22 04:01:27

回答 2查看 222关注 0票数 1

我的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'
 * }
 */

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

api-doc

koa-static

node.js

koa

回答 2

Stack Overflow用户

发布于 2019-05-04 20:37:23

它用于命名和导航名称。

<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更改，现在是可选的。如果未设置apiName，则从类型和路径自动生成名称：@api {类型} /path/ ->内部自动生成this @apiName TypePath。

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

票数 1

Stack Overflow用户

发布于 2020-05-14 23:18:23

我是这样实现的：

/**
 * @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
 .....

票数 1

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/54815324

复制

相似问题

问Apidoc - Node.js没有显示@apiName
EN

回答 2

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问Apidoc - Node.js没有显示@apiNameEN

回答 2

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问Apidoc - Node.js没有显示@apiName
EN