Libinkai

  前后端分离之后,接口文档是前后端沟通的必要手段。然后接口文档包含大量的重复性工作,费时费力,像apidoc这样工具就十分必要了。

  官方文档:http://apidocjs.com/

  --------------------------------------------------------------------------------------------------

  首先说一下自己遇到的坑:

  1、安装,node.js版本要高(在官网下最新的就行),不然后面有的模块会出问题,导致apidoc无法使用。

  

  2、生成接口文档之后,把文档放到服务器上面,发现接口文档无法加载

  看一下浏览器的请求,发现是有些资源无法加载,但是文件确实是存在的

  

  后来发现是请求被nginx转发到tomcat里面了,修改一下nginx的配置文件即可,或者直接把文档放到tomcat目录下,通过其它端口(8080)访问。

 

  3、同一个apiGroup下的多个接口,生成出来时只有部分接口

   在同一个@apiGroup下,名称@apiName相同的@api通过@apiVersion区分,否则后面@api会覆盖前面定义的@api,要确保每个接口的@apiName不相同。

  

分类:

技术点:

相关文章:

  • 2021-05-28
  • 2021-04-25
  • 2021-05-19
  • 2021-12-08
  • 2021-09-25
  • 2022-12-23
  • 2022-12-23
  • 2022-12-23
猜你喜欢
  • 2021-12-18
  • 2022-01-29
  • 2022-02-24
  • 2021-10-01
  • 2021-08-27
  • 2022-12-23
相关资源
相似解决方案