https://github.com/cameron-c-chapman/simple-spring-rest-service
Simple REST microservice implementation using Spring Boot.
https://github.com/cameron-c-chapman/simple-spring-rest-service
rest-microservice spring spring-boot swagger-ui
Last synced: 2 months ago
JSON representation
Simple REST microservice implementation using Spring Boot.
- Host: GitHub
- URL: https://github.com/cameron-c-chapman/simple-spring-rest-service
- Owner: Cameron-C-Chapman
- License: mit
- Created: 2016-12-15T23:37:25.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-10-29T21:46:26.000Z (over 8 years ago)
- Last Synced: 2025-03-20T06:16:32.269Z (over 1 year ago)
- Topics: rest-microservice, spring, spring-boot, swagger-ui
- Language: Java
- Homepage:
- Size: 86.9 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# simple-spring-rest-service
develop:
[](https://travis-ci.org/Cameron-C-Chapman/simple-spring-rest-service)
[](https://codecov.io/gh/Cameron-C-Chapman/simple-spring-rest-service)
master:
[](https://travis-ci.org/Cameron-C-Chapman/simple-spring-rest-service)
[](https://codecov.io/gh/Cameron-C-Chapman/simple-spring-rest-service)
### About
This repo is an example of a simple spring rest service that demonstrates some good practices (in my opinion) of how to structure a spring boot rest service and how to integrate unit testing, continuous integration, and code coverage reporting.
### Running the Application
```
./gradlew clean assemble
./gradlew bootRun -Dspring.profiles.active=local
```
### Testing the Application
* Unit testing
```
./gradlew test
```
* Through swagger-ui
* With the application running navigate to [http://localhost:9000/swagger-ui.html](http://localhost:9000/swagger-ui.html)
* You will see several controllers exposed including the Customer Controller which exposes the functionality for viewing all customers, viewing a specific customer, and adding a customer.
* For more information on swagger visit [http://swagger.io/](http://swagger.io/)
* Through Postman
* Importing the Postman collection into Postman and testing the pre-configured calls.
```
/resources/postman/simpleSpringRestService.postman_collection.json
```
* For more information on Postman visit [https://www.getpostman.com/docs/](https://www.getpostman.com/docs/)
* Through Advanced Rest Client
* Importing the Advanced Rest Client project into Advanced Rest Client and testing the pre-configured calls.
```
/resources/advanced-rest-client/simpleSpringRestService.json
```
* For more information on Advanced Rest Client visit [https://advancedrestclient.com/](https://advancedrestclient.com/)
### Some Things Not Included With This Demo
* Authentication
* How authentication needs to be setup is pretty dependent on the way it plans to be used within the environment it is being deployed and the systems it needs to interact with so I left it out of this demo.
### Some Things Included With This Demo
* Continuous Integration
* Continuous integration is configured through TravisCI. For more information on TravisCI visit [https://docs.travis-ci.com/](https://docs.travis-ci.com/)
* Code Coverage Analysis
* Code coverage analysis is configured through codecov.io. For more information on codecov.io visit [https://codecov.io/](https://codecov.io/)
* Interactive documentation through swagger-ui and pre-configured test suites through Postman and Advanced Rest Client.