问题标签 [api-doc]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
2391 浏览

php - ApiDoc 错误:未找到解析器插件“apimethod”

我用 Slim 框架编写了一个 RESTful API。对于文档,我想使用 APIDoc。我通过 npm 安装了 apidoc(没有 sudo 就无法工作)

我在一个项目文件(users.router.php)中插入了这个示例注释

我还添加了一个 apidoc.json 文件。然后我尝试通过调用生成文档

尝试生成文档时出现几个错误:

这是完整的输出:

我不知道出了什么问题。它可能是由“sudo”安装引起的吗?

0 投票
1 回答
899 浏览

swagger - 我在哪里可以找到/修改 Loopbackjs 模型元数据?

正如您现在可能看到的那样,Loopbackjs 框架显示了一个基于 swagger 的浏览器界面,公开您的 API 端点并简要解释这些方法。问题是这个界面有点太多的交互性。

我需要为我的 API 提供一个 api-docs (ish) 文档,我目前正在 /common/models js 文件中添加 @annotations,但我怀疑我在这里重新发明了轮子。为了让 swagger-ui / loopback-explorer 显示其界面,端点必须已经暴露了某种元数据,对吧?

我想得到它并用描述、示例、自定义状态代码来完成它,并且没有“尝试”按钮。看到这一点的用户不会欣赏这么多的交互性。

0 投票
1 回答
2824 浏览

rest - 为 Swagger 编写 api-doc

我正在尝试使用 Swagger UI,它说我应该首先编写一个描述 REST api 的确切 api 的 api-doc。问题是我不知道这意味着什么。这份文件是用简单的英文写的吗?或者是否有某种格式可以生成 UI?

谢谢!

0 投票
6 回答
6482 浏览

api - Apdocjs 文档创建问题,警告:找不到插件参数解析器和缺少逗号问题

我尝试使用 apidocjs 创建 API 文档,但在编译项目以在项目文件夹上使用 apidoc.json 创建 apidoc 时遇到问题。

代码在这里:

结果

请任何人帮我解决这个问题

与 apidocjs.com 相关的标签

0 投票
1 回答
10162 浏览

node.js - 需要为使用 nodejs/express 编写的现有应用程序创建一个 api 文档

我有一些用普通的旧快递写的私人 api。是时候放出它并提供一些 api 文档了。

我不希望(至少现在)它重写我的快速应用程序以将 api 文档集成到代码中。主要是因为我不确定要使用什么框架或规范来记录我的 api,所以我真的不想锁定一件事。

我想将文档作为我的 api 下的子资源的一部分提供(即我不想运行不同的服务器或子域)。也许是'/api/docs'。一个加号也是我可以嵌入到我的应用程序中的 UI,它可以解析文档并至少提供一个很好的 html 文档演示(api 交互是一个加号)。

swagger-node之类的东西很酷,但需要我重新编写所有快速代码以集成 swagger。那时我有一笔巨额投资,而且我与 swagger 紧密相连。

有没有办法以对现有路线的侵入性最小的方式提供招摇或 iodocs 或其他东西来记录我的 api?

编辑:

我可以从手写文档中提供 Swagger 规范。我看到的问题是您必须basePath在 swagger 文档中定义。这并不能真正让我在不同的域下轻松部署。

0 投票
1 回答
75 浏览

livescript - LiveScript API-Doc 创建?

对于 JavaScript,我使用 JSDuck,我应该为 LiveScript 使用什么?

似乎评论没有保留在 JS 源中。

0 投票
0 回答
851 浏览

php - “nelmio_api_doc.sandbox.authentication”下无法识别的选项“type”

从 nelmio api doc 调用 api 时遇到问题,来自 Postman 扩展的 api 工作

配置.yml

有人可以解决我的问题吗?谢谢 !

0 投票
1 回答
77 浏览

nltk - NLTK 3 第 4 版 API 文档

大家好,只是一个简单的问题。我正在使用 nltk Version 3 Release 4 (Python 3)。我只能找到 3.0 版的 API 文档,而且版本之间似乎有一些折旧。

例如 API 文档(对于 3.0)状态 nltk.ConditionalFreqDist应该有一个方法pprint。源代码中没有出现,也不是方法。

有什么地方可以获取更新的文档,或者我可以自己生成这些文档吗?下面的文档?nltk.ConditionalFreqDist也有点薄,没有列举方法。

另外(除此之外)折旧方法而不是在次要版本之间完全删除它们不是更传统吗?

0 投票
1 回答
2866 浏览

api-doc - 如何在 api-doc 中设置数组响应?

我尝试通过apidoc生成 API 文档

如果我的响应是一个数组

我如何在@apiSuccess 中设置?

我尝试过 Object[] 但不知道如何设置字段名称。谢谢。

0 投票
0 回答
730 浏览

java - swagger api 模型正在显示包装类

我们正在使用 swagger 作为文档。我们在 Pojo 上提到了@ApiModel,这里的问题是,如果你有任何包装类,如 Integer、BigDecimal 等,它也会记录这些类。

这是Pojo,

这是上述模型的招摇文档,

请建议我一种摆脱招摇文档中不需要的对象的方法。