问题标签 [api-doc]

我们使用 Sandcastle（帮助文件生成器）创建 API 文档，现在想将它们集成到 Visual Studio 2008 中。如何将 API 集成或添加为外部（Web）资源？

PSSQ 代表可能是愚蠢的 Scala 问题:)

稍微了解一下 Scala，在强制性的 Hello World 示例（下面的代码）中，主函数的参数是一个字符串数组。

在示例中，我map()在数组上使用该函数。但是，当我查看 Scala API 文档时，map()并未将其列为可用于Array. 是否发生了某种魔术，或者我在 API 文档中遗漏了一些明显的东西？

如果一个类实现了接口中定义的方法，您可以选择是复制文档还是使用<see cref="..." />.

是否可以让 API 文档工具（Sandcastle）自动复制文档（怎样才能让阅读 API 文档更舒服）？类似于@inheritDocJava Doc 的东西？

我正在尝试清理我的 python 代码文档，并决定使用sphinx-doc，因为它看起来不错。我喜欢如何使用以下标签引用其他类和方法：

我试图弄清楚如何在函数中记录参数名称，以便如果我有如下函数：

这方面的最佳做法是什么？

更新：

正确的语法是：

我已经下载了 swagger ui 并在本地进行了实验。它在 "path"、"body" 和 "query" 等场景中运行良好。但是我的大多数用例都使用了其余注释。

即 /resourcePath/;tags 用于检索特定资源标签的 URI。

当我尝试这个时，添加分号时 UI 会变得混乱，并且排序的 UI 格式不正确，并且不能超出此范围。

那么这是一个已知的限制吗？有没有办法实现这个目标？感谢对此的任何输入..

I create an API RESTfull using Symfony2.1 with FOSRESTBundle and I am using NelmioApiDocBundle to generate automatic documentation.

I have a PUT request in which the user should send one parameter, but I don't need to create a Form for this purpose. All works perfectly but when I generate the documentation I don't know how to add this parameter to the documentation because I don't have a 'input' form.

I tried this but seems doesn't work:

In the documentation of NelmioApiDocBundle I didn't see any solution for this...

默认情况下，Swagger 解析类的数据成员，以便记录用作参数或由给定 Web 服务返回的对象。如果您使用的是 Jackson，Jackson 注释会提供更准确的 API 描述。

有谁知道让 Swagger 解析 Jackson 注释的（简单）方法。也许是一个被覆盖的解析器？

source2swagger 在一个 json 文件中生成一个包含所有 api 的 swagger 规范。swagger-ui 真的可以使用它吗？当我使用 swagger-ui 探索生成的 json 文件时，它会尝试从规范中的路径读取 api 描述，而不是使用单个 json 文件中的描述/操作。

在 Swagger API 文档中，在 apis 数组旁边的 json 中有一个模型对象条目，但没有关于它的文档。我怎样才能使用这个“模型”部分？

我使用http://apidocjs.com/为我正在构建的 Express.js API 创建公共文档。我的问题是，如何使用 Express.js 来路由和提供文档？

这是我的 Express 服务器设置：

这是我用来创建文档的 grunt 文件：

有谁知道我如何在不为每个页面声明 app.get('.. 的情况下托管我的文档？某个地方的教程会很棒。

提前致谢。