|
1 | | -[Stack Overflow](https://stackoverflow.com/questions/tagged/light-4j) | |
2 | | -[Google Group](https://groups.google.com/forum/#!forum/light-4j) | |
3 | | -[Gitter Chat](https://gitter.im/networknt/light-rest-4j) | |
4 | | -[Subreddit](https://www.reddit.com/r/lightapi/) | |
5 | | -[Youtube](https://www.youtube.com/channel/UCHCRMWJVXw8iB7zKxF55Byw) | |
6 | | -[Documentation](https://doc.networknt.com/library/json-schema-validator/) | |
7 | | -[Javadocs](https://www.javadoc.io/doc/com.networknt/json-schema-validator) | |
8 | | -[Contribution Guide](https://doc.networknt.com/contribute/) | |
9 | | - |
10 | | -[](https://travis-ci.org/networknt/json-schema-validator) [](https://codecov.io/github/networknt/json-schema-validator?branch=master) |
11 | | - |
12 | | - |
13 | | -This is a Java implementation of the [JSON Schema Core Draft v4-v7](http://json-schema.org/latest/json-schema-core.html) specification for JSON schema validation. In addition, it also works for OpenAPI 3.0 request/response validation with some [configuration flags](doc/config.md). The default JSON parser is the [Jackson](https://github.com/FasterXML/jackson) that is the most popular one. As it is a key component in our [light-4j](https://github.com/networknt/light-4j) microservices framework to validate request/response against OpenAPI specification for [light-rest-4j](http://www.networknt.com/style/light-rest-4j/) and RPC schema for [light-hybrid-4j](http://www.networknt.com/style/light-hybrid-4j/) at runtime, performance is the most important aspect in the design. |
14 | | - |
15 | | -## Why this library |
16 | | - |
17 | | -#### Performance |
18 | | - |
19 | | -It is the fastest Java JSON Schema Validator as far as I know. Here is the testing result compare with the other two open-source implementations. It is about 32 times faster than the Fge and five times faster than the Everit. |
20 | | - |
21 | | -fge: 7130ms |
22 | | - |
23 | | -everit-org: 1168ms |
24 | | - |
25 | | -networknt: 223ms |
26 | | - |
27 | | -You can run the performance tests for three libraries from [https://github.com/networknt/json-schema-validator-perftest](https://github.com/networknt/json-schema-validator-perftest) |
28 | | - |
29 | | -#### Parser |
30 | | - |
31 | | -It uses Jackson that is the most popular JSON parser in Java. If you are using Jackson parser already in your project, it is natural to choose this library over others for schema validation. |
32 | | - |
33 | | -#### Dependency |
34 | | - |
35 | | -Following the design principle of the Light Platform, this library has minimum dependencies to ensure there are no dependency conflicts when using it. |
36 | | - |
37 | | -Here are the dependencies. |
38 | | - |
39 | | -``` |
40 | | - <dependency> |
41 | | - <groupId>com.fasterxml.jackson.core</groupId> |
42 | | - <artifactId>jackson-databind</artifactId> |
43 | | - <version>${version.jackson}</version> |
44 | | - </dependency> |
45 | | - <dependency> |
46 | | - <groupId>org.slf4j</groupId> |
47 | | - <artifactId>slf4j-api</artifactId> |
48 | | - <version>${version.slf4j}</version> |
49 | | - </dependency> |
50 | | - <dependency> |
51 | | - <groupId>org.apache.commons</groupId> |
52 | | - <artifactId>commons-lang3</artifactId> |
53 | | - <version>${version.common-lang3}</version> |
54 | | - </dependency> |
55 | | -``` |
56 | | - |
57 | | -#### Community |
58 | | - |
59 | | -This library is very active with a lot of contributors. New features and bug fixes are handled quickly by the team members. Because it is an essential dependency of the [light-4j](https://github.com/networknt/light-4j) framework in the same GitHub organization, it will be evolved and maintained along with the framework. |
60 | | - |
61 | | -## Prerequisite |
62 | | - |
63 | | -The library supports Java 8 and up. If you want to build from the source code, you need to install JDK 8 locally. To support multiple version of JDK, you can use [SDKMAN](https://www.networknt.com/tool/sdk/) |
64 | | - |
65 | | -## Dependency |
66 | | - |
67 | | -This package is available on Maven central. |
68 | | - |
69 | | -Maven: |
70 | | - |
71 | | -```xml |
72 | | -<dependency> |
73 | | - <groupId>com.networknt</groupId> |
74 | | - <artifactId>json-schema-validator</artifactId> |
75 | | - <version>1.0.27</version> |
76 | | -</dependency> |
77 | | -``` |
78 | | - |
79 | | -Gradle: |
80 | | - |
81 | | -``` |
82 | | -dependencies { |
83 | | - compile(group: "com.networknt", name: "json-schema-validator", version: "1.0.27"); |
84 | | -} |
85 | | -``` |
86 | | - |
87 | | -For the latest version, please check the [release](https://github.com/networknt/json-schema-validator/releases) page. |
88 | | - |
89 | | -## [Quick Start](doc/quickstart.md) |
90 | | - |
91 | | -## [Validators](doc/validators.md) |
92 | | - |
93 | | -## [Configuration](doc/config.md) |
94 | | - |
95 | | -## [Specification Version](doc/specversion.md) |
96 | | - |
97 | | -## [YAML Validation](doc/yaml.md) |
98 | | - |
99 | | -## Known issues |
100 | | - |
101 | | -I have just updated the test suites from the [official website](https://github.com/json-schema-org/JSON-Schema-Test-Suite) as the old ones were copied from another Java validator. Now there are several issues that need to be addressed. All of them are edge cases, in my opinion, but need to be investigated. As my old test suites were inherited from another Java JSON Schema Validator, I guess other Java Validator would have the same issues as these issues are in the Java language itself. |
102 | | - |
103 | | -[#7](https://github.com/networknt/json-schema-validator/issues/7) |
104 | | - |
105 | | -[#5](https://github.com/networknt/json-schema-validator/issues/5) |
106 | | - |
107 | | -## Contributors |
108 | | - |
109 | | -Thanks to the following people who have contributed to this project. If you are using this library, please consider to be a sponsor for one of the contributors. |
110 | | - |
111 | | -[@stevehu](https://github.com/sponsors/stevehu) |
112 | | - |
113 | | -[@jiachen1120](https://github.com/jiachen1120) |
114 | | - |
115 | | -[@BalloonWen](https://github.com/BalloonWen) |
116 | | - |
117 | | -[@eskabetxe](https://github.com/eskabetxe) |
118 | | - |
119 | | -[@ddobrin](https://github.com/ddobrin) |
120 | | - |
121 | | -[@ehrmann](https://github.com/ehrmann) |
122 | | - |
123 | | -[@rhwood](https://github.com/rhwood) |
124 | | - |
125 | | -[@nitin1891](https://github.com/nitin1891) |
126 | | - |
127 | | -[@jawaff](https://github.com/jawaff) |
128 | | - |
129 | | -[@kosty](https://github.com/kosty) |
130 | | - |
131 | | -[@chenyan71](https://github.com/chenyan71) |
132 | | - |
133 | | -[@chrisken](https://github.com/chrisken) |
134 | | - |
135 | | -[@NicholasAzar](https://github.com/NicholasAzar) |
136 | | - |
137 | | -[@basinilya](https://github.com/basinilya) |
138 | | - |
139 | | -For all contributors, please visit https://github.com/networknt/json-schema-validator/graphs/contributors |
140 | | - |
141 | | -If you are a contributor, please join the [GitHub Sponsors](https://github.com/sponsors) and swithch the link to your sponsors dashboard via a PR. |
142 | | - |
143 | | -## Sponsors |
144 | | - |
145 | | - |
146 | | -### Individual Sponsors |
147 | | - |
148 | | - |
149 | | -### Corporation Sponsors |
150 | | - |
151 | | - |
152 | | - |
| 1 | +## This is a fork of https://github.com/networknt/json-schema-validator to support Android 6 API >=23 |
0 commit comments