美文网首页
如何优雅的使用接口文档

如何优雅的使用接口文档

作者: LOC_Thomas | 来源:发表于2019-03-05 17:19 被阅读0次

现在微服务的开发模式,避免不了前后端进行联调的工作。所以后端定义了接口,是需要输出给前端开发人员的。

  • 目前java体系使用最多的是springfox进行集成,网上有很多相关的文章和代码,这里就不着重介绍了。下面讲讲在工作中发现的springfox的优势和劣势

具有的优势

  • SpringBoot集成相对简单,只需要引入对应的jar包,进行一些简单配置就可以使用
  • 接口文档页面随着进程一起启动,一起关闭,并且直接可以访问当前服务的接口,方便本地和测试环境的开发和调试
  • eureka方便进行结合,直接从eureka可以通过链接地址点到对应的服务swagger页面

存在的劣势

  • 如果是微服务,那么每个实例启动都会带有接口文档页面,造成微服务的jar包相对臃肿、服务启动时间变长
  • 文档应该和服务不进行耦合,没有服务应该前端人员也可以查看接口文档
  • 只能访问本地进程的服务
  • 对于没有外网地址的云主机,无法打开接口文档页面,进行调试

现有的问题

  • 目前我们服务部署在阿里云上面,并且微服务部署的服务器,没有外网地址,所以不能直接使用springfox进行集成,办公网络无法进行访问。
  • 微服务启动时间变长,想尽量减少依赖的jar包,提升服务启动速度。
  • 不想文档页面依赖于启动的服务,需要进行解耦

相关文章

  • 接口文档的编写

    参考资料 如何优雅的格式化接口 如何优雅的“编写”api接口文档 接口文档的编写

  • 如何优雅的使用接口文档

    现在微服务的开发模式,避免不了前后端进行联调的工作。所以后端定义了接口,是需要输出给前端开发人员的。 目前java...

  • 如何使用文档工具进行 API 管理?

    在进行接口管理过程中,正确使用文档工具能协助我们快速全面地管理接口文档。所以今天我们来谈谈接口文档以及如何使用接口...

  • 如何优雅管理接口文档

    接口文档生成流程 介绍 目前我们QA在测试过程中, 存在着接口文档不全或有出入(包括更新)的情况。 这时候我们一般...

  • 如何优雅的“编写”api接口文档

    前言 今天我需要把之前写的接口整理成文档,老大给了意见用swagger搞,我像发现新大陆一样的兴奋,迫不及待得去“...

  • 如何高效优雅地管理接口文档

    前言 你是一个测试,你们团队目前开发模式是前后端分离。 某一天,版本V1.0接口评审完,发布在了swagger上,...

  • 如何优雅的“编写”api接口文档(续)

    接着上一篇如何优雅的“编写”api接口文档 这篇续篇主要说一下以下三点 文件上传参数配置 单独部署SwaggerU...

  • Ansible2.0 Api接口调用

    Ansible Api 学习文档 Ansible Api接口的文档太少,先来一堆学习的资料 1.如何使用Ansib...

  • swagger2如何进行接口排序

    项目中使用的是springboot2.0+swagger2作为接口文档。遇到一个问题,如何对接口做排序让看接口的更...

  • 工作总结 文章目录

    工作总结 文章目录 狼人杀拾旧后台接口文档 狼人杀俱乐部后台接口文档 狼人杀接口文档 OA使用文档(报表,人事) ...

网友评论

      本文标题:如何优雅的使用接口文档

      本文链接:https://www.haomeiwen.com/subject/hlmouqtx.html