https://github.com/cassiomolin/jersey-springboot
Example of REST API using Spring Boot, Jersey and Jackson.
https://github.com/cassiomolin/jersey-springboot
jackson java jersey postman rest rest-api spring spring-boot
Last synced: 8 months ago
JSON representation
Example of REST API using Spring Boot, Jersey and Jackson.
- Host: GitHub
- URL: https://github.com/cassiomolin/jersey-springboot
- Owner: cassiomolin
- License: mit
- Created: 2017-06-04T20:04:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-07-20T08:47:37.000Z (about 8 years ago)
- Last Synced: 2024-12-29T05:13:48.739Z (9 months ago)
- Topics: jackson, java, jersey, postman, rest, rest-api, spring, spring-boot
- Language: Java
- Homepage:
- Size: 22.5 KB
- Stars: 1
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# REST API using Spring Boot and Jersey
[](https://travis-ci.org/cassiomolin/jersey-springboot)
[](https://raw.githubusercontent.com/cassiomolin/jersey-springboot/master/LICENSE.txt)
This example application demonstrates how to create a REST API using:
- **Spring Boot:** Framework for creating standalone Java applications.
- **Jersey:** JAX-RS reference implementation for creating RESTful web services in Java.
- **Jackson:** JSON parser for Java.
## Building and running this application
To build and run this application, follow these steps:
1. Open a command line window or terminal.
1. Navigate to the root directory of the project, where the `pom.xml` resides.
1. Compile the project: `mvn clean compile`.
1. Package the application: `mvn package`.
1. Change into the `target` directory: `cd target`
1. You should see a file with the following or a similar name: `jersey-springboot-1.0.jar`.
1. Execute the JAR: `java -jar jersey-springboot-1.0.jar`.
1. The application should be available at `http://localhost:8080/api`.
## REST API overview
See the [curl][] scripts below with the REST API supported operations:
### Get a greeting
```bash
curl -X GET \
'http://localhost:8080/api/greetings' \
-H 'Accept: text/plain'
```
### Get the current date
```bash
curl -X GET \
'http://localhost:8080/api/current-date' \
-H 'Accept: application/json'
```
## Targeting the REST API with Postman
Alternatively to [curl][], you can use [Postman][] to target the REST API. The Postman collection files are available in the [`src/main/postman`](src/main/postman) directory.
[Postman]: https://www.getpostman.com/
[curl]: https://curl.haxx.se/