问题标签 [api-doc]

我是开发 REST Web 服务的新手，现在，我正在尝试通过以下网址添加身份验证：http: //developers-blog.helloreverb.com/enabling-oauth-with-swagger/

不幸的是，我被困在第一步，当它说要编辑资源列表时，我相信这是 api-docs，对吗？那么，如果它由服务生成并且没有在任何地方存储为文件，我应该如何编辑它？

我的 Swagger 版本是 1.2

在为我的 API 文档安装“npm”和“node”之后，我通过以下命令安装了“apidoc”：

在全局安装 apidoc 后，我只是在我的项目目录上运行以下命令（假设 apidoc 将考虑其默认模板文件）：

结果没有错误，也没有生成文档。

同样，我尝试过：

但是什么都没有发生，在那种情况下，我在“mytemplate”目录上什么都没有。

你们能告诉我我错过了安装/考虑什么吗？为什么在命令执行中什么也没有出现？

注意：我将它用于我的 ruby​​ 应用程序，但无法安装它的 gem，因为我们在 ruby​​ 1.9 上运行我们的应用程序并且它需要 ruby​​ 2.0。我需要一个独立的解决方案，它也应该适用于其他项目。

谢谢你。

我正在使用 Swagger 编辑器生成 YAML/JSON 代码，该代码将在 Swagger UI 中显示我的 API 的详细信息。

我希望我的 API 的使用者能够查看 API 文档的修订历史记录（例如，添加的字段、从“可选”更改为“必需”的字段等）。Swagger 是否支持此功能？

过去几天我一直在使用 APIdoc.js，但我似乎无法弄清楚如何使版本控制工作。我知道我需要根据 APIDOC 将旧的 APIDOC 注释代码保存到另一个文件中，其中包含@APIVersioning新/旧代码。无论我把这个旧文件放在哪里，我似乎都无法让它工作，而且这个例子中没有任何关于它如何加载旧代码来创建这个版本的提示。任何协助将不胜感激。

我目前正在使用 Symfony2 构建一个 RESTful API。

为了创建一个简单而干净的文档，我希望使用apidoc.js（我真的更喜欢使用这个，但是如果您有其他任何东西可以自动生成 api 文档，请随时分享）。

该生成器使用由 Symfony 内核解析的注释（显然，据我了解）

这是我的控制器代码

可悲的是，Symfony 解析了这个，并给我一个错误：

您是否碰巧有一个解决方案来阻止 Symfony 解析注释（我一直在使用 YAML，所以 Symfony 注释实际上对我没有用），或者只是导入那些？

我对此很陌生，我仍在努力创建一个可靠且干净的 Symfony 应用程序。

以下是我大摇大摆的定义：

尝试在 editor.swagger.io 上验证我的 api-doc 时出现以下错误。有什么想法吗？

浏览了几个教程和文档，包括这里的主要文档。按照它，创建了两个文件：

1）example.js

2) 测试python.py

将它们都保存在一个文件夹中，例如“my_project”。在 mac 终端上，转到“my_project”的父目录。运行脚本：

得到错误：

这是基本的，但不知何故，没有取得成功。

我想自动记录我的 REST-API。我知道，有很多工具可以做到这一点，但我想从我的单元测试中生成文档。

这样做的原因是，我希望文档能够反映，什么是测试的，什么不是。尽管如此，文档应该像swagger生成的文档一样丰富。

我已经找到了两个使用这种方法的项目，doctester和testdoc4j。两者都不能满足我的需要。生成的文档不会汇总快乐路径和错误路径。

你使用什么工具，你能推荐任何好的工具吗？

干杯。

编辑：

记录在接口中定义的 API 合同和记录测试场景是有区别的。如果我的文档只包含经过测试的端点和路径，我可以定义我的界面并且只能分发我测试过的部分。

这意味着我可以用十个端点定义一个接口。在用相应的测试实现一个基本功能后，我可以用文档发布这部分。尚未包含尚未稳定或已实现的端点，这会阻止用户使用它们。

我正在使用 Spring 安全性设置 OAuth 2.0 授权服务器。我想使用 Swagger 记录 OAuth 2.0 API。我该怎么做呢？

像这样的 Zend_Form：

我通读了 ZF1 1.12 API 和参考文档，但在 Zend_Form::addElement() 配置选项中找不到标志“ignore”的含义。

api文档就是这样的：

当然，我用谷歌搜索并找到了它，但这不是工作方式。如何找到某些特定内容的含义。我不认为我需要阅读源代码？

仅以此addElement()为例，我是否错过了进一步研究的地方？在Zend_Config类中我也找不到关于ignore标志的任何内容。