2 Star 0 Fork 751

王露 / apiManager

forked from 阿凉 / xiaoyaoji 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
README.md 3.68 KB
一键复制 编辑 原始数据 按行查看 历史
周靖杰 提交于 2016-11-03 15:41 . 修改readme

LOGO

特点

  • 在线接口测试 目前支持 json,text,html,xml,jsonp,Websocket
  • markdown编辑器

在线demo (推荐使用在线系统)

文件夹说明

  • web 文件夹是前端静态页面 基于nodejs,webpack gulp,vuejs,jqueryjs开发完成
  • api 使用java开发,运行在tomcat7.x以上版本。maven,druid,mariadb

兼容性

  • 静态页系统暂时只兼容chrome,其他浏览器未测试。
  • 后端:jdk1.7 tomcat7 mariadb5.5

使用说明

文件夹说明

api : 接口 web : 静态页面 - extension:浏览器扩展 - config.js 一些页面配置 - gulp.js gulp构建器 - html 网页源码 - package.json - webpack.config.js webpack配置 ##开发版本

API

  • api/src下面为源码,基于maven项目构建。
  • 修改api/src/main/resources/config.properties 中的数据库配置信息,
    • 如果需要使用第三方登录,需要配置对应的地址
    • 如果需要使用邮件发送,需要配置sendcloud邮箱配置信息
    • config.properties未单独做中文编码处理,为防止乱码,中文需要改为unicode
  • 导入api/sql/xiaoyaoji.sql 文件导入到mysql中,
  • 启动tomcat,浏览器运行 http://localhost:端口/index.html 能正常显示则表示可用。

申明一下:如果只是需要离线部署,请直接看 『直接使用』下面的介绍,如果是需要二次开发,api是java代码,web是静态代码。

API 依赖jar org.mangoframework.core 1.2.3

 项目及使用说明都在这:http://git.oschina.net/zhoujingjie/mangoframework
 或者直接下载附件中的jar

WEB

  • npm install 下载项目依赖包

  • npm run watch 编译并且监听文件改动

  • npm run server 运行开发项目-文件夹 (用于开发过程中)

  • 浏览器访问http://localhost:8080/ 可以看到正在开发中的项目

  • npm run build 编译项目,并且生成built文件夹

  • gulp 将built文件夹及html文件夹代码打包到dist文件夹中;

  • npm run dist-server 运行dist文件夹下的项目(也就是编译后的项目,一般用于上线前最后测试。)

  • 浏览器访问http://localhost:8080/ 可以看到编译打包后的项目

  • 修改html/assets/js/config.js配置

    • window.xyj.ws 地址为ws://你的ip:端口
    • window.xyj.api地址为 api的地址,默认是当前工程目录,如果你的api是单独部署,则改为改api对应的 http://ip:port

直接使用

  • 下载https://git.oschina.net/zhoujingjie/apiManager/tree/master/releases 中的最新版本的zip包(之前是放在附件中,附件上传速度太慢改为这了)
  • 复制解压的内容到tomcat/webapps/ROOT 目录下(注意,项目只能运行在一级目录中,如:xxx.com,或者api.xxx.com ,不能是xxx.com/apimanager)
  • 需要修改的地方
    • 导入api/sql/xiaoyaoji-MMdd.sql 到mysql中。mysql需要5.5以上
    • 修改/WEB-INF/classes/config.properties中的数据库配置信息。
    • 修改 /assets/js/config.js 的配置 (如果api未单独部署则无需修改)
      • window.xyj.ws 地址为ws://你的ip:端口
      • window.xyj.api地址为 api的地址,默认是当前工程目录,如果你的api是单独部署,则改为改api对应的 http://ip:port * ### 1023bug,现在部分windows机器上tomcat下出现接口404问题,临时解决方法是替换tomcat为jetty,或者在linux下部署

效果

基本 基本 基本 基本

1
https://gitee.com/luwang/apiManager.git
git@gitee.com:luwang/apiManager.git
luwang
apiManager
apiManager
master

搜索帮助