README.md

apijson-framework

腾讯 APIJSON 服务端框架，通过数据库表配置角色权限、参数校验等，简化使用。
Tencent APIJSON Server Framework for configuring access of roles and validation of arguments in database tables, then using APIJSON easier.

Access: https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/MethodAccess.java

Request: https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/orm/Operation.java

添加依赖

Add Dependency

Maven

1. 在 pom.xml 中添加 JitPack 仓库

1. Add the JitPack repository to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

2. 在 pom.xml 中添加 apijson-framework 依赖

2. Add the apijson-framework dependency to pom.xml

	<dependency>
	    <groupId>com.github.APIJSON</groupId>
	    <artifactId>apijson-framework</artifactId>
	    <version>LATEST</version>
	</dependency>

https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-Java-Server/APIJSONDemo/pom.xml

Gradle

1. 在项目根目录 build.gradle 中最后添加 JitPack 仓库

1. Add the JitPack repository in your root build.gradle at the end of repositories

	allprojects {
		repositories {
			maven { url 'https://jitpack.io' }
		}
	}

2. 在项目某个 module 目录(例如 app) build.gradle 中添加 apijson-orm 依赖

2. Add the apijson-orm dependency in one of your modules(such as app)

	dependencies {
	        implementation 'com.github.APIJSON:apijson-framework:latest'
	}

初始化

Initialization

1.在你项目的主程序启动类 Application 的 static {} 代码块配置 APIJSONApplication.DEFAULT_APIJSON_CREATOR，至少重写 createSQLConfig 方法返回你自己继承 APIJSONSQLConfig 的子类

1.Configure APIJSONApplication.DEFAULT_APIJSON_CREATOR in static {} of your Application, at least override createSQLConfig method and return your SQLConfig extends APIJSONSQLConfig.

	static {
		APIJSONApplication.DEFAULT_APIJSON_CREATOR = new APIJSONCreator<Long>() {
			@Override
			public SQLConfig createSQLConfig() {
				return new DemoSQLConfig();
			}
		};
	}

2.在你项目的主程序启动类 Application 的 main 方法里 SpringApplication.run 后调用 APIJSONApplication.init

2.Call APIJSONApplication.init after SpringApplication.run in main method of your Application

	public static void main(String[] args) throws Exception {
		SpringApplication.run(DemoApplication.class, args);
		APIJSONApplication.init();
	}

见 apijson.framework 里各个类的注释及 APIJSONDemo 里的 DemoApplication

See document in apijson.framework classes and DemoApplication in APIJSONDemo

使用

Usage

Access: https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/MethodAccess.java

Request: https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/orm/Operation.java

有问题可以去 Tencent/APIJSON 提 issue
Tencent/APIJSON#36

贡献者

Contributors

1 个腾讯工程师、1 京东工程师 等，感谢大家的贡献~
1 Tencent engineer, 1 JD engineer, etc. Thank you all~
https://github.com/APIJSON/apijson-framework/graphs/contributors

创作不易、坚持更难，点右上角 ⭐Star 支持一下，谢谢 ^_^

Please ⭐Star this project ^_^

https://github.com/APIJSON/apijson-framework