站内导航

站点默认项目
站点默认项目,请勿删除
V7快速部署指南

快速部署:


1.下载源码,编译成功后,部署至tomcat下

2.执行源码中的sql脚本,修改编译后的数据库配置(配置文件:class/config.properties)

3.修改其他配置:class/config.properties (邮箱、github、域名等)

4.启动项目,使用最高管理员登陆,进入系统管理-》系统设置管理-》修改Lucene文件地址(请确保该地址存在,且tomcat用户具有所有权限),修改其他配置


快速入门帮助:


1. 系统账号等级:最高管理员、普通管理员、普通用户(开启注册功能后,注册的用户均为普通用户)

      最高管理员:使用最高管理员登陆系统后,在系统管理-》用户管理-》修改(在角色栏选择【最高管理员】即可将普通管理员升级成最高管理员)

      普通管理员:具有普通用户的所用功能,若拥有相应的权限或角色(角色等于多个权限的集合)后,可协助管理站点:系统设置、用户管理、站点文章管理、站点菜单管理....

      普通用户:通过站点注册的用户,可以新建项目、模块、接口、文章、数据字典、资源、错误码等

2. 项目

      系统所有用户均能创建项目,创建项目后拥有该项目的所用功能。同时可以为项目添加成员,项目成员的权限可以配置(拥有18中权限),项目下能新建模块、错误码

3. 模块

      一个项目可以有多个模块,模块下能新建接口、资源、数据字典、文章等

4.项目密码、模块密码

     模块密码优先级大于项目密码,设置项目密码或模块密码后,游客浏览项目下的所有资源均需要输入密码

5.私有项目、公开项目

     私有项目下的所有资源均不建立全文索引,私有项目必须登录后才能访问(用户是该项目的成员,或项目创建者,或最高管理员),为保证系统安全,安装系统后请修改最高管理员密码,进入【系统设置管理】修改【SECRETKEY】:系统加密、下载等秘钥,不能包含#、=、?、\ 、空格。建议使用大小写、数字、下划线、逗号、点等

    公开项目下的资源将建立全文索引(通过项目顶部的搜索,输入关键字通过全文索引查询),公开项目可以添加密码,访问时必须通过密码访问

6.推荐项目

     推荐项目将在主页面【推荐项目】菜单下显示



配置简介:


###### 数据库配置 #####

jdbc.driverClassName=com.mysql.jdbc.Driver

jdbc.url=

jdbc.username=

jdbc.password=


###  站点配置  ###

#域名

web.domain=http://localhost:8080/api

#是否开放注册

web.openRegister=true

#全文索引是否需要登陆才能使用

web.luceneSearchNeedLogin=false

#私有项目是否建立索引

web.privateProjectNeedCreateIndex=false


##### 缓存配置:ip为空,则使用内存缓存,否则使用reids缓存 #####

web.redisIp=

web.redisPort=6379

# 为空串则表示没有密码

web.redisPwd=

#reids连接池大小

web.redisPoolSize=50

web.redisKeyPrefix=api:crap:


##### 缓存时间配置 #######

#缓存时间,单位:s

web.cacheTime=3600

#用户登录信息缓存时间(最后一次后台操作时间超过该时间,登录信息将失效):s

web.loginInforTime=3600


##### 主页面菜单配置 #######

#首页左边菜单是否默认显示推荐的项目

web.showRecommendProject=true

#首页左边推荐显目菜单名称

web.recommendProjectMenuName=推荐项目

#首页左边是否显示站点文章

web.showArticle=true

web.articleMenuName=推荐文章

#文章分类、项目显示的数量

web.subMenuSize=6


###### 上传配置 ########

#上传文件大小限制,单位:M

web.fileSize=2

#允许上传的文件类型

web.fileType=,gif,jpg,jpeg,png,bmp,ico,

#允许上传的图片类型

web.imageType=,txt,doc,xls,xlsx,rar,zip,pdf,docx,


##### 监控配置 ########

#接口监控线程数量,最高1000个

web.monitorThreadNum=20

#接口监控查询数据库缓存时间,单位s,小于等于0表示不缓存

web.monitorCacheTime=0

#访问失败后尝试次数,最多100次,最小1次

web.monitorTryTimes=10

#一小时内,告警邮件发送指数,最小为2,最大为10:指数越小,3小时内告警邮件发送越多。如为2,则邮件发送时间为第1、2、4、8、16、32、64、128...s

#注意:邮件发送受监控周期配置的影响,默认监控周期为30s,即30s才检查一次,以上邮件发送时间是根据监控周期为1s计算的

web.monitorEmailSendIndex=3


###    163 邮箱配置  ### 

# 邮箱

mail.username=

mail.host=smtp.163.com

#密码/授权码

mail.password=

mail.auth=false  

mail.timeout=10000  


####  第三方登陆 GitHub,登陆github在个人中心获取即可  ####

github.clientID=

github.clientSecret=


V7新增功能:


1. 修改项目结构、模块下不允许再建模块

2.模块下可以添加数据字典、文章、资源,添加重建Lucene索引功能,添加按模块批量下载接口功能、添加密码找回、修改密码、github登陆、优化后台菜单配置(前端左侧住菜单默认显示文章、推荐模块,删除后台菜单配置)、添加我的项目模块、推荐项目模块、添加mock功能、添加邮件发送功能、添加接口监控功能(频率可配置)、添加评论管理、添加评论回复功能、接口添加时类型改为下拉选择、接口调试返回json格式自动格式化、文章接口等编辑页面添加全屏功能......

3.新增项目成员功能(成员权限配置)

4.优化表结构、优化项目bug....

注意:V5升级V7: http://api.crap.cn/index.do#/web/article/detail/web/ARTICLE/a00534f1-7e50-45e2-9e72-fc9ede829dec