swagger 这种用的多吗?

虽然很方便,但是感觉对代码有侵入,总感觉怪怪的

阅读 8.3k
7 个回答

对代码没有侵入,做临时对接还是比较好用的,api文档的话建议自己留文档。另外注意生产环境要关闭swagger

你是怎么定义“侵入”的?

Swagger 支持 AOP,可以利用反射的方式自动扫描 Controller + Action,是可以做到业务代码无侵入的。

如果你指的“侵入”是说还得在项目里写 Swagger 配置和代码……

题主想说的是用的人多不多而不是觉得swagger对代码有"侵入"对吧!

按我的观点用的还是蛮多的.

  • 多个优秀开源项目主推swagger.
  • 前后端联调不要太简单
  • 动态的api文档
  • 和他类似的框架没见过或者不太成熟

所以我在第一次见到swagger后第一时间就集成了它.

希望能被采纳.感谢

确实有侵入
但是目前成熟的也就这一家,没得选

    @ApiOperation(value = "post请求调用示例", notes = "invokePost说明", httpMethod = "POST")
    public FFResponseModel<DemoOutputDto> invokePost(@ApiParam(name="传入对象",value="传入json格式",required=true) @RequestBody @Valid DemoDto input) {
        log.info("/testPost is called. input=" + input.toString());
        return new FFResponseModel(Errcode.SUCCESS_CODE, Errcode.SUCCESS_MSG);
    }

代码摘自Swagger介绍及使用

以前有在项目上集成过swagger,标准做法的确有代码入侵。下面的代码就是为了生成接口注释必须写的侵入代码。
@ApiOperation(value = "post请求调用示例", notes = "invokePost说明")
@ApiParam(name="传入对象",value="传入json格式",required=true)
如果直接扫描controller+action,只能通过方法参数和方法注释生成接口信息,类似javadoc那种操作,则是无代码入侵的实现方式之一。

个人看法:
如果能很好的执行swagger代码管理,并且强调这个,那是挺好用的,在线测试很方便,再自定义修改下swagger的UI,很漂亮哈哈。
但是 项目上用得比较少 。实际上很多时候项目流程和代码不够规范,对测试的要求也比较低,所以没那么多讲究。

新手上路,请多包涵

还是蛮多的,

感觉就是把你写接口文档的功夫,放在接口上写swagger了

撰写回答
你尚未登录,登录后可以
  • 和开发者交流问题的细节
  • 关注并接收问题和回答的更新提醒
  • 参与内容的编辑和改进,让解决方法与时俱进
推荐问题