zoukankan      html  css  js  c++  java
  • 接口文档自动生成工具apidoc

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

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

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

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

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

      

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

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

      

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

     

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

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

      

  • 相关阅读:
    redis存储session配制方法
    thanks使用注意事项;
    mongodb sort limit和skip用法
    mongoose的用法(注:连接数据库)
    mongoose查询特定时间段文档的方法
    webworker的使用案例
    js 传参数
    redis.config翻译
    Oracle keep详解
    自学之笔记总结
  • 原文地址:https://www.cnblogs.com/Libinkai/p/10358045.html
Copyright © 2011-2022 走看看