站内导航

帮助文档
乱码、二次开发、使用等帮助文档
项目私有化部署
CrapApi开源接口管理系统,API管理,接口管理,apimanger。压缩包中一般均会包含对应版本的sql脚本,直接执行该脚本即可,!!原因:本人使用workbench工具导出脚本,使用其他工具导入时可能会提示报错,请根据报错原因,自行修复!!!

文章来自:CrapApi —— API接口管理系统,转载请注明出处!

CrapApi所有演示系统(官网、试用)及数据库均使用阿里云服务器,为了保证系统安装顺利,建议购买阿里云Centos系统服务器:http://tb.cn/sI3Hw6x

1.下载编译后的文件直接部署或下载源码编译安装

  • 下载编译后的文件及数据库文件:http://api.crap.cn/index.do#/web/article/detail/web/ARTICLE/a00534f1-7e50-45e2-9e72-fc9ede829dec
  • 导入mysql数据库(数据库初始化超级管理员账号:admin  123456)部署数据库(mysql),部署数据库(mysql)
  • 执行压缩包或项目源码中的所有sql脚本:压缩包中一般均会包含对应版本的sql脚本,直接执行该脚本即可,不需要再执行任何其他sql脚本!!!
  • 修改CrapApi/WEB-INF/classes/config.properties 中的数据库连接等配置
  • 修改CrapApi/WEB-INF/classes/log4j.properties 中的日志输出地址



2.手动部署至tomcat

在tomcat/conf/server.xml <Engin> </Engine>节点中添加一下配置信息
<Host name="域名或ip"
unpackWARs="true" autoDeploy="true"
xmlValidation="false" xmlNamespaceAware="false">
<Context path="访问路径" docBase="文件地址" debug="0" reloadable="true" crossContext="true" ></Context>
</Host>
域名或ip,如:api.crap.cn
访问路径:如:crapapi 或不填,如填写crapapi则对应的访问地址为http://api.crap.cn/crapapi 不填则为http://api.crap.cn
文件地址:解压后的crapApi地址,如D:/CrapApi


3. 部署成功后登陆系统修改系统设置:DOMAIN(系统部署的域名),LUCENE_DIR(V3版本:Lucene索引文件存储地址)、修改【SECRETKEY】:系统加密、下载等秘钥,不能包含#、=、?、\ 、空格。建议使用大小写、数字、下划线、逗号、点等

4.下载源码自己编译(见:项目二次开发指南

5.注意修改tomcat内存相关配置:tomcat默认只使用了64M内存

修改tomcat bin目录中的catalina.sh (linux)或 catalina.bat(windows), 新增如下配置:(示例参数为centos 64位系统,单核1G内存,请根据服务器合理调整参数大小)

JAVA_OPTS="-Xms100m -Xmx200m -XX:PermSize=100m -XX:MaxPermSize=200m -Xss512K"

6.添加GitHub登陆:修改config.properties 中的github授权及秘钥(登陆gith,添加OAuth Application,回调地址填写:http://部署域名/github/login.do)

CrapApi所有演示系统(官网、试用)及数据库均使用阿里云服务器,为了保证系统安装顺利,建议购买阿里云Centos系统服务器:http://tb.cn/sI3Hw6x


快速部署:


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

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

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

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


快速入门帮助:


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

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

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

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

2. 项目

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

3. 模块

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

4.项目密码、模块密码

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

5.私有项目、公开项目

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

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


配置简介:

jdbc.driverClassName=com.mysql.jdbc.Driver

jdbc.url=jdbc:mysql://localhost:3306/apidev?useUnicode=true&characterEncoding=utf-8

jdbc.username=apidev

jdbc.password=apidev

jdbc.initialSize=10

jdbc.maxActive=100

jdbc.minIdle=10

jdbc.testWhileIdle=true

jdbc.validationQuery=SELECT NOW()

jdbc.filters=stat

### 站点配置 ###

#域名

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

#是否开放注册

web.openRegister=true

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

web.luceneSearchNeedLogin=false

#缓存时间,单位:s

web.cacheTime=3600

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

web.loginInforTime=7200

#接口url是否能重复

web.canRepeatUrl=true

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

web.fileSize=2

#允许上传的文件类型

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

#允许上传的图片类型

web.imageType=,gif,jpg,jpeg,png,bmp,ico,webp

### 阿里企业邮箱 ### 

#mail.username=

#mail.host=smtp.mxhichina.com

#mail.password=

#mail.auth=false

#mail.timeout=10000

### 163 test2015 ### 

mail.username=crap_cn@163.com

mail.host=smtp.163.com

mail.password=xxx

mail.auth=false 

mail.timeout=10000 

#### 第三方登陆 GitHub ####

github.clientID=198bcac070c454e23cf1

github.clientSecret=1dd69ad93c1e7f739deaf95fd1807e192300ea99

#### 第三方登陆 码云 ####

git.oschina.clientID=93b820393bddda5a24fdff8ac9d6ec08473934dd3735b48f843d57e21be3bf7b

git.oschina.clientSecret=7101c54ed31e5f2bf4a129c2f8d27c3373acf4848ad8550ef1af2e10735cdac8


文章来自:CrapApi —— API接口管理系统,转载请注明出处!

©crap.cn  本系统由CrapApi开源项目生成