问题标签 [api-doc]

使用 sphinx-apidoc 生成.rst文件时，输出产生不包含任何标签：

我要做的是从自定义主页链接到特定页面，该主页不是使用 apidoc 生成的。但是，我找不到任何方法来调用 api-doc 并让它自己生成标签，我也找不到任何正确的方法来简单地链接到.rst没有标签的右侧，而不是简单地输入我知道的绝对 html 文件产生。

我可以使用该::include语句，它工作得很好，但我完全无法找到一个语句，它只会生成一个指向第一个文件的超链接。

我在这里遗漏了一些明显的东西，还是我必须想办法制作 api-doc 插入标签？

干杯

我已经开始使用apidoc生成 REST api 文档。我用它尝试了不同的东西。

在我flask基于 api 的应用程序中，我使用JWT（特别是 flask-jwt）进行身份验证。文档被正确生成，但来自文档的请求没有正确发生。

这是我放置docsting用于生成文档的地方

当我生成文档时，它会正确生成

1. 但是当我从生成的文档中传递凭据时，请求失败。我在烧瓶的请求中得到的请求数据是''（空的）
2. Content-Type即使在文档字符串中包含标题后，它也会失败。我在烧瓶的请求中得到的请求数据是username=test@example.com&password=test123

我已经通过在 Flask-JWT 的代码中添加调试点来确认上述内容

但是，当我使用postman它提出相同的请求时，它会正确发生。

邮递员标头

Apdoc 标头

我错过了什么？

当我生成我的 API 文档时，指向索引页面左侧每个单独 API 的链接当前是根据 API 的描述生成的。

我希望链接名称是方法类型（在上面的示例post中）和@apiName的组合。对于此块注释：

我希望这个 API 的链接文本是POST - Create Cake

有没有办法做到这一点？

我使用apidocjs来设置我的 asp.net web api 应用程序的文档。当我在visual studio中运行我的web api时，一切都在我的机器上运行良好，但在我部署应用程序的服务器上却没有。导航到 apidocjs 生成的 index.html 时出现 404 错误。我认为这是IIS的问题。

我需要有关如何解决此问题的建议？

ROR Api Dock 总是以方法的语法开头。我的例子是link_to：

link_to(name = nil, options = nil, html_options = nil, &block) public

我的问题是我在大多数命令中看到的"name=nil"or 。"something = nil"

第二个例子： url_for(options = nil)

有人可以解释这是什么意思或它想说什么..这是否意味着该选项是可选的？

它为什么如此重要..

所以我有一个用Lumen创建的 API，其中一些文档是用公用文件夹之外的Apdoc 完成的，我想在用户访问 URL 时提供它http://apidomain.com/docs

这是应用程序的结构

有没有办法创建将用户发送到 API/Docs 的路由？

我想用来在项目springfox中生成 API 文档。springmvc但是通过使用springfox，我必须在控制器和模型中添加java注解，这是非常具有侵入性的。那么我该怎么做才能以一种侵入性较小的方式使用它呢？或者还有什么框架可以做到这一点？（不知道能不能表达清楚。）

我正在为使用 yiisoft/yii2-apidoc (#0.2.4) 用 yii2 编写的项目构建文档。我已经构建了一个 shell 脚本来发布文档，当我只包含项目文件和我自己的通过 composer 引入的 cms 代码库时，它工作正常。

这是代码

所以这会生成包含我所有代码的文档......

但是当我添加 yii 框架时问题就来了——我需要它来显示我的代码继承的方法和参数。所以添加了 yii2 框架的新代码是......

这会生成仅列出 yii2 代码的文档 - 我的所有课程都已消失（见下面的屏幕截图）。我在这里看不到我做错了什么，有人可以帮忙吗？

我正在为其他人编写的 nodejs 项目编写apidocs。我希望在有人访问“myurl.com/docs/api”时显示文档页面。我的文档目录被放置在“app/public/app/docs/apidoc/”下，我正在尝试使用路由来显示它，但给了我一个错误说明：

'错误：在视图目录“/Path/To/Project/app/views”中查找视图“/public/app/apidoc/index.html”失败'

这是我的 routes.js 条目：

我相信该项目使用了 jam 和 ejs，因为它们在配置文件中的某处列出。

我想修改 Django REST Swagger 生成的 Swagger 文档。我想找到 Django REST Swagger 生成的 API 定义或模式文件。我一直无法找到那些文件。

当 Django REST Swagger 创建 API 文档时，是否会生成类似 YAML 或 JSON 文件？

我在哪里可以找到服务器上的那个文件？

谢谢！