个人中心
文章发布
退出
作者热门文章
- mongodb - 在 MongoDB mapreduce 中，如何展平值对象？
- javascript - 对象传播与 Object.assign
- html - 输入类型 ="submit"Vs 按钮标签它们可以互换吗？
- sql - 使用 MongoDB 而不是 MS SQL Server 的优缺点
25
4
我使用 Java Jersey(和 JAXB)编写了一个相当广泛的 REST API。我也使用 Wiki 编写文档，但它是一个完全手动的过程，非常容易出错，尤其是当我们需要进行修改时，人们往往会忘记更新 wiki。
环顾四周，大多数其他 REST API 也在手动创建他们的文档。但我想知道是否有一个好的解决方案。
每个端点需要记录的内容有:
当然还有一些通用的东西是全局的，比如
这些一般的东西只需描述一次就可以了，不需要自动化，但是对于 Web 服务方法本身来说，自动化它似乎是非常可取的。
我考虑过可能使用注释，并编写一个生成 XML 的小程序，然后编写一个 XSLT，它应该在 HTML 中生成实际文档。使用自定义 XDoclet 是否更有意义？
最佳答案
Swagger是一个不错的选择。这是 GitHub 上的一个项目，具有 Maven 集成和许多其他选项以保持灵 active 。
集成指南:https://github.com/swagger-api/swagger-core/wiki
更多信息:http://swagger.io/
关于java - 如何自动化 REST API 的文档( Jersey 实现)，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/1714029/
25
4
0
关闭。这个问题需要details or clarity .它目前不接受答案。 想改进这个问题吗？ 通过 editing this post 添加细节并澄清问题. 关闭 5 年前。 Improve t
背景 我有一个 Azure Runbook(名为 RunStoredProcedure2)，定义如下: param( [parameter(Mandatory=$True)] [string] $Sq
我有一个名为“团队”的表，其中包含“非事件”列，另一个表“事件”，其中包含“时间”列。如果任何团队的“事件”中的最新日期发生在 X 时间之前，如何将“非事件”列更新(为 true)？ 我知道这可以通过
下面的问题可能有点令人困惑，但我会尽力以最好的方式解释它。 假设我们为一家制造公司工作。它制造然后用于制造产品的组件。在以下示例中，有 3 个组件和 2 个最终产品。 组件和产品的需求如下: comp
我有代码可以让我在一个范围内选择一个项目: COleVariant vItems = cstrAddr; hr = AutoWrap(
我正在开发一个应用程序，该应用程序有 4 种语言的大约 50 个应用内购买，这给了我很多表单和子表单、框和子框，需要使用 iTunesConnect 的令人痛苦且设计糟糕的表单来填充。 我想知道是否有
我想在 Azure 自动化中使用 powershell 脚本来安排打开/关闭资源。 我想在不创建帐户的情况下执行此操作，因为我们的域强制重置密码。我知道自动化帐户会创建一个证书 - 当使用资源管理器(
我尝试从 azure 自动化 run book power shell 自动检索 azure SQL 数据库中的数据。我发现azure自动化帐户的模块中缺少SQL Server模块。我已经导入了该模块
我正在自动化 Outlook，并且需要控制电子邮件的发件人身份。用户将在 Outlook 中设置两个或多个帐户，我需要能够选择从哪个帐户发送电子邮件。有什么想法吗？ 需要 Outlook 2003 及
我尝试从 azure 自动化 run book power shell 自动检索 azure SQL 数据库中的数据。我发现azure自动化帐户的模块中缺少SQL Server模块。我已经导入了该模块
假设我有一个网站，我可以(随时)登录并每隔 x 小时提交数据(单击登录后可见的链接)，我将如何自动化此过程？ 我构建了一个图形用户界面，它为用户(现在是我，为了我自己的方便)提供了一个包含一些信息的界
我正在开发一个程序，它的任务是我们为它定义一些号码(我们的一些手机号码)并且它应该在 Telegram 中注册它们，然后获取发送到该号码的所有消息。如您所知，在 Telegram 中注册需要提供电话号
关闭。这个问题需要更多focused .它目前不接受答案。 想改进这个问题吗？ 更新问题，使其只关注一个问题 editing this post . 关闭 3 年前。 Improve this qu
最近我在处理 CSS Sprite 。一切正常。 我创建了一个 sprite、.css 文件和 html 结构。看起来像 .sprites{ background-image:url
我想为一款名为 Dune 2000 的策略游戏创建一个叠加层。令人讨厌的是，要创建 10 个士兵，每次完成一个都必须单击该图标。没有队列。因此，在不干扰游戏运行方式的情况下，我想听听鼠标移动的声音，当
我是 python 的初学者，我想从自动化开始。以下是我正在尝试执行的任务。 ssh -p 2024 root@10.54.3.32 root@10.54.3.32's password: 我尝试通过
当我将一些 urlencoded Javascript 粘贴到 Firefox 和 Chrome 上的 URL 时，我看到了一些奇怪的事情发生。是否可以使用此技术告诉 Chrome 访问 URL，然后
我需要将大量请求自动提交到基于云的数据库接口(interface) (Intelex)。没有任何方法可以批量提交某些操作，但是提交单个请求所必需的只是让经过身份验证的用户尝试打开 Web 链接。因此，
假设我有一个进程的内存转储。我想对其运行报告，所以基本上我想打开 WinDBG，加载 SOS 并运行一个脚本，该脚本运行一些命令，解析输出，然后基于此运行更多命令。 除了像 SendKeys 这样的
我正在使用 ffmpeg 创建视频剪辑。我想自动化该过程并保存剪辑，而无需手动为要保存的每个文件命名。这是我拥有的代码。它将创建并保存剪辑，但只能使用扩展名和不是名字。 @echo off cd /d
我是一名优秀的程序员,十分优秀！