草庐IT

java - Swagger - 如何使用 swagger-codegen 并长期构建项目

coder 2024-03-18 原文

Swagger 项目非常适合用各种语言轻松创建客户端和服务器应用程序，但我不明白如何以适当的方式维护或扩展现有项目。

我正在生成一个 Java 服务器 - 语言参数是 jaxrs-spec。

我已经编写了自己的 Maven pom 并使用了 swagger-codegen-maven-plugin，所以现在我可以直接使用 maven 生成模型或 api。

我发现每次重建我的项目时，API 都会被 swagger-codegen 插件完全重写。

我需要实现我的应用程序逻辑，目前除了自定义生成的 API 源之外我没有看到任何其他方法。 因此，为了避免在每次构建时丢失我的工作，我可以配置 .swagger-codegen-ignore(我确实这样做了)，但我只是推迟了这个问题。

因为第一次我必须更新 swagger.json，所以我唯一的选择是重新生成整个 API 并覆盖我的工作。好的，我可以使用 git 并尝试恢复删除的部分，但这确实是一个丑陋的解决方案。

所以，问题是:

使用 swagger-codegen(或一般的 Swagger)是否有一种模式、一种方法、一种记录的方式允许我添加行为和/或扩展生成的 API 而不会覆盖我的代码？

最佳答案

这取决于您选择的语言/模板，因为其中一些比其他的更灵活，但同样的原则也适用:您不应该在生成的代码中添加任何额外的逻辑。 不幸的是，通过查看 sample for jaxrs-spec ，这些模板看起来不如说的那些好，jaxrs-resteasy .

此时，您可以:

  1. 将模板切换到不同的 jaxrs
  2. 编写自己的模板并使用它们
  3. 修改/更新 swagger-codegen 模板并将它们提交回来。

我将逐步解释如何为其他模板完成此操作。目前完成的方式是通过工厂，但它可以通过依赖注入(inject)轻松完成。 Codgen 生成作为 API 样板的 stub 实现，并将实际逻辑委托(delegate)给另一个类。

对于 jaxrs-resteasy，这是 codegen 为 GET/{username} 方法生成的内容(我删除了它也放入的 swagger 注释):

@GET
@Path("/{username}")
@Produces({ "application/xml", "application/json" })
public Response getUserByName( @PathParam("username") String username,@Context SecurityContext securityContext)
throws NotFoundException {
    return delegate.getUserByName(username,securityContext);
}

实际的方法只是委托(delegate)给一个工厂，它是这样获取的:

private final UserApiService delegate = UserApiServiceFactory.getUserApi();

它能做到这一点是因为它还为 API 生成了一个基类来实现:

public abstract class UserApiService {
    // methods omitted...
    public abstract Response getUserByName(String username, SecurityContext securityContext) throws NotFoundException;
    // methods omitted...
}

现在，在非生成代码中，用户添加了这个基类的实现:

public class UserApiServiceImpl extends UserApiService {
      // methods omitted...
      @Override
      public Response getUserByName(String username, SecurityContextsecurityContext) throws NotFoundException {
          // do some magic!
          return Response.ok().entity(new ApiResponseMessage(ApiResponseMessage.OK, "magic!")).build();
    }
    // methods omitted...
}

然后用户在codegen期望的package中添加factory，这样生成的代码就可以得到上面的实现:

public class UserApiServiceFactory {
   private final static UserApiService service = new UserApiServiceImpl();

   public static UserApiService getUserApi() {
      return service;
   }
}

现在生成的代码确切地知道要委托(delegate)给 UserApiService 的哪个实现。此时，整个服务器样板与应用程序逻辑分离，允许您重新生成 API 而无需覆盖您的自定义逻辑。

此答案假定 jaxrs-spec 的示例是 swagger-codegen 为该语言参数生成的内容的准确示例。有时它们会过时。

关于java - Swagger - 如何使用 swagger-codegen 并长期构建项目，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/41892647/

swagger-codegenSwaggercodecodegenjavamavenswagger-2.0

有关java - Swagger - 如何使用 swagger-codegen 并长期构建项目的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri，根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 如何从 ruby​​ 中的字符串运行任意对象方法？ - 2

    总的来说，我对ruby​​还比较陌生，我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础，我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

  3. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

    我有一个Ruby程序，它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重，我想提高压缩级别，因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗？是否有另一个允许指定压缩级别的Ruby库？ 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

  4. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法？ - 2

    类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

  5. ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2

    很好奇，就使用ruby​​onrails自动化单元测试而言，你们正在做什么？您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您？git中的预提交Hook？只是手动调用？我完全理解测试，但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的，并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您？ 最佳答案 不确定您到底想听什么，但是有几个级别的自动代码库控制:在处理某项功能时，您可以使用类似autotest的内容获得关于哪些有效，哪些无效的即时反馈。要确保您的提

  6. ruby - 在 Ruby 中使用匿名模块 - 2

    假设我做了一个模块如下:m=Module.newdoclassCendend三个问题:除了对m的引用之外，还有什么方法可以访问C和m中的其他内容？我可以在创建匿名模块后为其命名吗(就像我输入“module...”一样)？如何在使用完匿名模块后将其删除，使其定义的常量不再存在？ 最佳答案 三个答案:是的，使用ObjectSpace.此代码使c引用你的类(class)C不引用m:c=nilObjectSpace.each_object{|obj|c=objif(Class===objandobj.name=~/::C$/)}当然这取决于

  7. ruby - 使用 ruby​​ 和 savon 的 SOAP 服务 - 2

    我正在尝试使用ruby​​和Savon来使用网络服务。测试服务为http://www.webservicex.net/WS/WSDetails.aspx?WSID=9&CATID=2require'rubygems'require'savon'client=Savon::Client.new"http://www.webservicex.net/stockquote.asmx?WSDL"client.get_quotedo|soap|soap.body={:symbol=>"AAPL"}end返回SOAP异常。检查soap信封，在我看来soap请求没有正确的命名空间。任何人都可以建议我

  8. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声？ - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点？我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等)，但我确实想创建一个输出文件。

  9. ruby-on-rails - 如何验证 update_all 是否实际在 Rails 中更新 - 2

    给定这段代码defcreate@upgrades=User.update_all(["role=?","upgraded"],:id=>params[:upgrade])redirect_toadmin_upgrades_path,:notice=>"Successfullyupgradeduser."end我如何在该操作中实际验证它们是否已保存或未重定向到适当的页面和消息？ 最佳答案 在Rails3中，update_all不返回任何有意义的信息，除了已更新的记录数(这可能取决于您的DBMS是否返回该信息)。http://ar.ru

  10. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

    我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗？当我运行compasswatch时，它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行？文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们？我自己编译的.sass文件编译成compiled/t

随机推荐