Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jsonurl/jsonurl-java
JSON->URL defines a text format for the JSON data model suitable for use within a URL/URI (as described by RFC3986). This repository holds the Java reference implementation of JSON->URL.
https://github.com/jsonurl/jsonurl-java
apache-maven java json jsonurl jsr374 marshaling maven querystring text uri url
Last synced: 4 months ago
JSON representation
JSON->URL defines a text format for the JSON data model suitable for use within a URL/URI (as described by RFC3986). This repository holds the Java reference implementation of JSON->URL.
- Host: GitHub
- URL: https://github.com/jsonurl/jsonurl-java
- Owner: jsonurl
- License: apache-2.0
- Created: 2020-02-28T02:02:11.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-09T22:10:27.000Z (10 months ago)
- Last Synced: 2024-04-10T01:15:48.299Z (10 months ago)
- Topics: apache-maven, java, json, jsonurl, jsr374, marshaling, maven, querystring, text, uri, url
- Language: Java
- Homepage: http://www.jsonurl.org/
- Size: 6.2 MB
- Stars: 4
- Watchers: 3
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# JSON→URL
[](https://www.apache.org/licenses/LICENSE-2.0)
[](https://search.maven.org/search?q=g:org.jsonurl)
[](https://javadoc.io/doc/org.jsonurl/jsonurl-core)
[](https://github.com/jsonurl/jsonurl-java/actions?query=workflow%3Aci)
[](https://sonarcloud.io/dashboard?id=jsonurl-java)
[](https://sonarcloud.io/dashboard?id=jsonurl-java)
[](https://sonarcloud.io/dashboard?id=jsonurl-java)
[](https://sonarcloud.io/dashboard?id=jsonurl-java)
[](https://sonarcloud.io/dashboard?id=jsonurl-java)
[](https://sonarcloud.io/dashboard?id=jsonurl-java)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fjsonurl%2Fjsonurl-java?ref=badge_shield)
[](CODE_OF_CONDUCT.md)
[](CONTRIBUTING.md)
[json.org module][jsonorg-module]: [](https://snyk.io/test/github/jsonurl/jsonurl-java?targetFile=module/jsonurl-jsonorg/pom.xml)
[](https://javadoc.io/doc/org.jsonurl/jsonurl-jsonorg)
[javax.json module][jsr374-module]: [](https://snyk.io/test/github/jsonurl/jsonurl-java?targetFile=module/jsonurl-jsr374/pom.xml)
[](https://javadoc.io/doc/org.jsonurl/jsonurl-jsr374)
## About
[RFC8259][RFC8259] describes the JSON data model and interchange format, which is widely
used in application-level protocols including RESTful APIs. It is common for
applications to request resources via the HTTP POST method, with JSON entities.
However, POST is suboptimal for requests which do not modify a resource's
state. JSON→URL defines a text format for the JSON data model suitable
for use within a [URL][RFC1738]/[URI][RFC3986].
## Usage
The factory artifact defines a [generic][java-generic]
[JSON->URL parser][parser] and includes an implementation based Java SE
data types (e.g. [java.util.Map][java-map], [java.util.List][java-list], etc).
There are two additional modules, distributed as separate artifacts, which
implement a parser based on JSR-374 and Douglas Crockford's Java API.
### [Java SE][java-util] API example:
```xml
org.jsonurl
jsonurl-factory
${jsonurl.version}
```
```java
import java.util.Map;
import org.jsonurl.j2se.JsonUrlParser;
JsonUrlParser p = new JsonUrlParser();
Map obj = p.parseObject( "(Hello:World!)" );
System.out.println(obj.get("Hello")) // World!
```
### [Json.org][javadoc-org-json] example:
```xml
org.jsonurl
jsonurl-jsonorg
${jsonurl.version}
```
```java
import org.json.JSONObject;
import org.jsonurl.jsonorg.JsonUrlParser;
JsonUrlParser p = new JsonUrlParser();
JSONObject obj = p.parseObject( "(Hello:World!)" );
System.out.println(obj.get("Hello")) // World!
```
### [JSR-374][javadoc-javax-json] example:
```xml
org.jsonurl
jsonurl-jsr374
${jsonurl.version}
org.glassfish
javax.json
${javax.json.version}
```
```java
import javax.json.JsonObject;
import org.jsonurl.jsonp.JsonUrlParser;
JsonUrlParser p = new JsonUrlParser();
JsonObject obj = p.parseObject( "(Hello:World!)" );
System.out.println(obj.get("Hello")) // World!
```
## Javadocs
All artifacts published to Maven Central include `sources` and `javadoc` JARs.
You can browse the current, and all previous revisions, via Javadoc.io:
+ [jsonurl-core](https://javadoc.io/doc/org.jsonurl/jsonurl-core)
+ [jsonurl-factory](https://javadoc.io/doc/org.jsonurl/jsonurl-factory)
+ [jsonurl-jsonorg](https://javadoc.io/doc/org.jsonurl/jsonurl-jsonorg)
+ [jsonurl-jsr374](https://javadoc.io/doc/org.jsonurl/jsonurl-jsr374)
Additionally, Javadocs are also generated automatically on pushes to
[main](https://jsonurl.github.io/jsonurl-java/).
## Security
The parser is designed to parse untrusted input. It supports limits on
the number of parsed values and depth of nested arrays or objects.
When the limit is exceeded a [LimitException][limit-exception] is thrown.
Sane limit values are set by default.
## License
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fjsonurl%2Fjsonurl-java?ref=badge_large)
[RFC8259]: https://tools.ietf.org/html/rfc8259
[RFC3986]: https://tools.ietf.org/html/rfc3986
[RFC1738]: https://tools.ietf.org/html/rfc1738
[java-generic]: https://docs.oracle.com/javase/tutorial/java/generics/types.html
[parser]: module/jsonurl-core/src/main/java/org/jsonurl/Parser.java
[limit-exception]: module/jsonurl-core/src/main/java/org/jsonurl/LimitException.java
[jsonorg-module]: module/jsonurl-jsonorg/src/main/java/org/jsonurl/jsonorg/JsonUrlParser.java
[jsr374-module]: module/jsonurl-jsr374/src/main/java/org/jsonurl/jsonp/JsonUrlParser.java
[java-map]: https://docs.oracle.com/javase/8/docs/api/java/util/Map.html
[java-list]: https://docs.oracle.com/javase/8/docs/api/java/util/List.html
[javadoc-org-json]: https://javadoc.io/doc/org.json/json/
[javadoc-javax-json]: https://javadoc.io/doc/javax.json/javax.json-api/
[java-util]: https://docs.oracle.com/javase/8/docs/api/java/util/