问题标签 [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.
node.js - 用于构建演示页面以详尽测试 API 的节点库
给定一个 API，我可以想象一个 javascript 库（Node 中的服务器端）可能存在，它可以构建演示页面来详尽地测试这些 API 方法。
像：https ://developers.google.com/apis-explorer
有人知道这样的图书馆吗？
symfony - 带有@QueryParam 的 FOSRESBundle 路由
我正在使用 Symfony 2.3.4 和 FOSRestBundle 0.13.1。我已将路由配置为由 FOSRestBundle 自动生成。在我将 @QueryParam 注释添加到任何方法之前，一切都很好。此注释更改了路由，而不是从 url 中提取变量，它希望将其作为参数传递。
IE
但是，一旦我添加了 @QueryParam 注释，我的路线就会更改为：
为什么我的路线会改变？是不是不能在保留原有路由的同时使用@QueryParam注解？
c# - 带有 Doxygen 的 ASP.NET Web API 帮助页面文档。可能吗？
是否可以使用 Doxygen 生成这种类型的 API 文档。如果有怎么办？
我确实有我所有的控制器 XML 注释。
django - django-rest-swagger 没有将 Markdown 文档字符串解析/翻译成 HTML 代码
到目前为止，我知道django-rest-swagger从 v0.1.10 开始支持 Markdown 语法中的文档字符串。但是当我尝试查看文档时，它显示为纯文本，而不是解析并将其转换为 HTML 代码。
我在用着：
API示例代码基于函数的视图：
当直接浏览 API 时，描述被正确翻译/呈现。
我错过了什么吗？
python - Python 模块/包名称的 Sphinx apidoc 部分标题
当我运行时sphinx-apidoc，make html它会在目录 (TOC) 中的每个模块/包名称的末尾生成包含“子包”和“子模块”部分以及“模块”和“包”的文档页面。在不编辑 Sphinx 源代码的情况下，如何防止编写这些额外的标题？
这是我想做的一个示例文档页面（注意 TOC）：
http://selenium.googlecode.com/svn/trunk/docs/api/py/index.html#documentation
我知道这是由于 sphinx 源代码中的 apidoc.py 文件（第 88 行）：
我可以手动编辑每个单独的 .rst 文件以删除这些标题，或者只是从脚本中删除这些代码行，但随后我必须编译 Sphinx 源代码。是否有一种无需手动编辑 Sphinx 源的自动方法？
python - 使用 setuptools 为 Python 项目自动生成文档
我创建了一个使用 setuptools 并具有以下结构的演示项目：
我正在尝试使用 Sphinx 为这个项目自动生成文档。到目前为止，我已经尝试过：
我觉得必须有一种更简单的方法来使用README,setup.py和 docstrings 自动生成此文档。
最终，我想为另一个使用 Python C-api 的项目自动生成 apidocs。我找不到任何东西。
我的主要问题是：有没有更简单的方法来自动生成这个文档？
json - 以 swagger json 格式生成 WebAPI 文档
我已经使用 .Net 4.5 创建了一个 WebAPI，并希望使用Swagger记录这个 API 。我在我的 .Net 项目中添加了swagger-ui 。现在，当我浏览到 ../swagger-ui/index.html 时，它成功地以 swagger UI 格式打开宠物商店 api-docs (json)。
我的问题是如何为我的 WebAPI 控制器和模型创建这样的 (swagger) json？正如我在 c# 类和属性中添加了所需的 XML 摘要/注释一样。
我看到Swagger.Net和Swashbuckle在那里做类似的事情，但我真的不明白如何使用它们中的任何一个来生成 swagger-json 文件。我可能犯了一个很小的错误，但无法指出。
请帮忙。
java - 如何在 Swagger 中添加有关 API 的更多信息？
我包含swagger-springmvc在我的项目中并设法让 Swagger UI 正常工作，但现在关于 UI 中的 API 的信息非常少。我所看到的只是通过反射提取的信息。
这是控制器方法的样子：
在每个方法的右侧，Swagger 记录了方法的名称，在这种情况下：
但我期待看到这个：
在 helloreverb.com 上的示例中，我看到了每种方法的描述。我怎样才能像这样大摇大摆地将我的控制器方法的描述添加到 UI 中？
android - “远程”是什么意思？
Android API 文档在谈论“远程对象”时是什么意思？
例如IBinder状态的 API 文档：
该接口描述了与远程对象交互的抽象协议。
但我已经搜索过，似乎找不到任何定义，例如“远程对象是......等等等等等等......”
node.js - apiDoc 的 package.json 放在哪里
我希望使用apiDoc来记录 WebAPI 接口。apiDoc 文档提到使用package.json文件来指定项目名称和最新 API 版本等内容。不幸的是，我无法让它工作。这个文件应该放在哪里？我已尝试将其放置在包含文档代码的文件夹中、包含生成的文档代码的文件夹中以及调用 apiDoc 的文件夹中，但在所有情况下我都会收到以下消息：
有没有我在这里没有找到的技巧？