An open API service indexing awesome lists of open source software.

https://github.com/softspiders/rest-api-java-jersey

Minimalistic RESTful web service in in Java (Jersey)
https://github.com/softspiders/rest-api-java-jersey

api java jersey min rest softspider softspiders ss template web web-service

Last synced: 3 months ago
JSON representation

Minimalistic RESTful web service in in Java (Jersey)

Awesome Lists containing this project

README

          

[SOFTSPIDERS](https://github.com/softspiders/softspiders)

# rest-api-java-jersey

Minimalistic RESTful web service in *Java*([*Jersey 2.x*](https://jersey.github.io/))

## Feature tags

- jersey
- starter
- template

## Requirements

* [*Java 7*](https://www.oracle.com/technetwork/java/javase/downloads/java-archive-downloads-javase7-521261.html)
* [*Apache Maven*](https://maven.apache.org/)
* Some servlet container for deploying and running: [*Apache Tomcat*](http://tomcat.apache.org/), [*Jetty*](https://www.eclipse.org/jetty/), ...

Оther dependencies including [*Jersey 2.x*](https://jersey.github.io/) are transitive and therefore installed under the hood.

## Code generation

All code of this repository is a source code for Servlet container deployable *Jersey 2.28* web-service and it is generated.
To create the source code, use

```sh
mvn archetype:generate -DarchetypeGroupId=org.glassfish.jersey.archetypes -DarchetypeArtifactId=jersey-quickstart-webapp -DarchetypeVersion=2.28
```

After several questions and your relevant answers, the source code of the web service will be generated.

## Build

Being in the just generated web-service directory, run:

```sh
mvn clean install
```

As a result, a distribution *war*-file will be obtained.

## Installation

The *war* distribution then should be deployed on your servlet container [*Apache Tomcat*](http://tomcat.apache.org/), [*Jetty*](https://www.eclipse.org/jetty/), ...)

## Running

The service can be tested from the browser by typing the corresponding URL
(depends on the servlet container specific) in its address bar.

## Authors

[Alexander Lapygin](https://github.com/AlexanderLapygin)

## Inspired by

[mvn archetype generation of *Jersey 2.28*](https://jersey.github.io/download.html)

### License

Licensed under the [MIT license](./LICENSE).