gpt4 book ai didi

swagger-2.0 - 使用 swagger 2.0 记录 REST API 时如何保持实现和文档同步?

转载 作者:行者123 更新时间:2023-12-04 16:13:56 25 4
gpt4 key购买 nike

我想使用 Swagger 2.0 来记录 REST API,因为这似乎被广泛用于记录 RET API。

但是,我不确定如何将文档和实现保持在 Sync 中?例如当我添加一个新的 API 时,我必须确保 API 文档中使用的模型(表示响应)应该与 REST 实现中创建的模型相同。同样,文档中给出的资源名称应该与实现中的资源名称匹配。

有没有办法从使用 swagger 2.0 规范生成的文档中只生成资源接口(interface)和模型类?

最佳答案

您可以使用这些工具生成服务器源(它们也可以生成客户端源):

  • http://studio.restlet.com : 在线编辑器,为java(Jax-RS和ReSTLet)和Node.js生成服务器骨架代码
  • http://editor.swagger.io : 在线编辑器,为 java (Jax-RS)、Node.js、Scalatra 和 Java Spring MVC 生成服务器骨架代码
  • https://github.com/swagger-api/swagger-codegen : swagger 代码生成器,可以尝试实现自己的生成器模块(我个人目前正在尝试使用这个)
  • 关于swagger-2.0 - 使用 swagger 2.0 记录 REST API 时如何保持实现和文档同步?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/30918462/

    25 4 0
    Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
    广告合作:1813099741@qq.com 6ren.com