问题标签 [api-doc]

我有一个 servlet，它可以处理多个路径并基于它做不同的事情。我想使用http://apidocjs.com记录类文件中的不同函数，但无法弄清楚如何让两个函数显示出来。当我尝试这个（见下文）时，只有第一个出现：

我有raml文档，并尝试将新的 API 文档添加到该文档中。

我浏览了基本的 RAML 文档。

我有 raml 文件。

实际的 raml 内容在test.raml

在上面的 RAML 中，400响应500很常见，name标头很常见。

我怎样才能写一次并添加到所有资源中？我试过了traits，<<:但都不起作用。

这是我第一次使用 apiDocs，我完全按照提供的文档进行操作。问题是我正在定义 apiName 和 apiGroup 但输出中只显示 apiGroup 。这是我的定义：

这是我的 apidoc.json：

但输出列表只是组名，忽略了 apiName：

其余的输出都很好。

我使用 docstrings 来记录 python 代码和 sphinx-autodoc 来生成 apidoc HTML。我的包的结构如下：mainpackage.subpackage.module，我希望 apidocs 链接到模块中的类，mainpackage.subpackage.Class而不是mainpackage.subpackage.module.Class. 我的问题来自scikit-multilearn项目，例如：我有一个MLClassifierBase类 in skmultilearn.base.base，但我将它导入__init__.pyin skmultilearn.base，我希望 sphinx 生成的 apidocs 只使用这个类，skmultilearn.base.MLClassifierBase而不是skmultilearn.base.base.MLClassifierBase像现在这样。有人可以帮忙吗？

我已经尝试过：

• add_module_names = False根据Sphinx conf.pyapidoc设置- 不打印包和模块的完整路径

• 添加""".. automodule:: base"""到skmultilearn/base/__init__.py

• 添加__all__ = ['MLClassifierBase']到skmultilearn/base/__init__.py

• 添加.. autoclass:: base.MLClassifierBase到类文档中

我仍然有一个Bases: skmultilearn.base.base.MLClassifierBase在每个派生自MLClassifierBase. 我该如何改变？

我逐字遵循 Spring Rest Doc的入门指南，但我无法从生成的片段中获取任何 html。

片段在我配置的目录（build/generated-snippets）中生成得很好，但我看不到任何 html5/ 目录，其中包含从片段中生成的 html 文件。

文档在某些时候说明了如何将文档打包到 jar 中，很明显它需要 html5/ 目录中的一些文件，但这不是在构建运行时创建的：

我错过了什么？

我的项目文件build.gradle：

和一个我用来测试的简单测试文件：

我正在使用 Symfony 框架，并打算将自动文档引擎添加到我项目的 RESTful api 中。

经过一番搜索，我找到了 apidoc 引擎（http://apidocjs.com/）。它的工作原理非常简单：您必须为 RESTful api 的每个控制器添加一些注释，然后生成文档。

注解的例子是：

可以看到，apidoc 的注解和 Symfony 中路由的注解是一样的。

顺便说一句，在生产环境中它工作正常，但在开发环境中我得到异常

有什么办法可以解决这个问题并向 Symfony 说必须忽略 apidoc 的注释？

我在一个带有 Spring Boot java 框架的项目中工作，其中家伙自动生成 API 文档。每次运行 BDD/Integration 风格的测试时，都会从 mocha 测试中创建 api 蓝图文件。然后它运行 generate-html-from-api 蓝图。我喜欢这种方法，因为它有两个优点：

有没有人尝试过并且有节点项目的工作示例？我找到了api-doc-test插件，但是它的文档是有限的。? 理想情况下，我只想运行：

这将生成 api-doc.html 并放在 test/tmp/ 下。

我看过 swagger，但我真的不想指定端点信息两次，而且在 BDD 测试中编写一次并同时获得双重结果（测试 + 文档）真的很棒。

将 expressJS 4.X 与 nodeJS 6.x 一起使用

我以前是这样定义我的路线的：

我发现这是正确的方法，因为：

• 您在路由定义之上编写路由文档
  • 如果修改路线，则修改文档
• 您的控制器上方有路由文档
  • URL 参数/正文内容 (req.params.name // req.body.name)
  • 要返回的 HTTP 错误代码
  • 像 webstorm 这样的 IDE 使用这些注释来自动完成

为了寻找最佳实践，我被多次告知我应该创建一个控制器并在其他地方进行路由定义，以以下代码结尾：

我看到以这种方式组织代码的唯一充分理由是，如果您有 2 条道路做同样的事情，您可以让它们使用相同的控制器。

• 我应该继续分开我的控制器和我的路线吗？
• 如果是，我应该如何记录它？
• 这样的代码组织有什么好处？

我们最近决定使用RAML来记录我们的 API，目前看来一切都很好。

我们正在使用raml2html实用程序来生成静态 HTML 文档。默认模板效果很好，但我看到了更好的 API 页面。有谁知道一些示例/现成模板的集合？

编辑：随着 RAML 的发展，它周围的工具也在不断发展。我最近发现了一个非常不错的主题，可能会感兴趣：https ://github.com/wdullaer/raml2html-slate-theme

当 JSON 片段中有一些额外的元素时，有没有办法禁用错误突出显示。我的用例是我想在 JSON 中包含注释以使其更易于理解。我知道它不是语言规范的一部分，但是在没有红色高亮的情况下做这样的事情会很酷：

是否可以在不修改包含的宝石的情况下轻松影响突出显示样式？

提前致谢！