forked from gCubeSystem/gx-rest
Add REAME.md
This commit is contained in:
parent
bf6dc1970b
commit
e3c4cdac3b
|
@ -0,0 +1,30 @@
|
|||
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.
|
||||
|
||||
gxRest has the flexibility for different degrees of exploitation of the library:
|
||||
* it can be entirely adopted both at client and service side with full benefit of its conventions;
|
||||
* it can be used just to send REST requests based only on plain HTTP;
|
||||
* it can be used to parse the HTTP code of a response;
|
||||
* it can be used only to return HTTP codes from the service.
|
||||
* it can be used only to return Exceptions from the service.
|
||||
|
||||
## 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
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project version="4">
|
||||
<component name="VcsDirectoryMappings">
|
||||
<mapping directory="$PROJECT_DIR$/.." vcs="svn" />
|
||||
<mapping directory="$PROJECT_DIR$/.." vcs="Git" />
|
||||
<mapping directory="$PROJECT_DIR$/.." vcs="Git" />
|
||||
</component>
|
||||
</project>
|
Loading…
Reference in New Issue