gx-rest/README.md

29 lines
1.1 KiB
Markdown
Raw Normal View History

2019-04-06 21:56:02 +02:00
gxRest
----
The gCube eXtensions to the Rest Protocol (gxRest) is a set of Java libraries designed to provide convenient round-trip interaction between a Restful web application (also known as "service") and its clients.
2019-04-06 22:09:37 +02:00
gxRest has the flexibility for different degrees of exploitation:
2019-04-06 21:56:02 +02:00
* it can be entirely adopted both at client and service side with full benefit of its conventions;
2019-04-06 22:09:37 +02:00
* it can be used to send REST requests based only on plain HTTP;
* it can be used only to return HTTP code/messagess from the service;
* it can be used only to throw Exceptions from the service to the client.
2019-04-06 21:56:02 +02:00
## Modules
* [gxHTTP](https://wiki.gcube-system.org/gcube/GxRest/GxHTTP)
* [gxJRS](https://wiki.gcube-system.org/gcube/GxRest/GxJRS)
## Deployment
Notes about how to deploy this on an infrastructure or link to wiki.
## Documentation
See gxRest on [Wiki](https://wiki.gcube-system.org/gcube/GxRest).
## Built With
* [JAX-RS](https://github.com/eclipse-ee4j/jaxrs-api) - Java™ API for RESTful Web Services
* [Jersey](https://jersey.github.io/) - JAX-RS runtime
* [Maven](https://maven.apache.org/) - Dependency Management
## License
TBP