hengdlkh / sample-spring-web-simple-restcontroller

This sample shows you how to implement a simple REST controller with Spring Web (and Spring Boot)

Spring Web simple REST controller sample

This sample shows how to implement a simple REST controller with Spring Web (and Spring Boot).

How to build and run

If you want to see the implementation in action, simply follow these steps:

• First, make sure that you have Java 8 or later installed and an established Internet connection.
• Then, clone this Git repository an cd into the project folder.
• Now invoke ./mvnw spring-boot:run and wait a moment.

After the project is built and the Spring Boot service is running you can hit the following urls to act with the service:

• http://localhost:8080 allows to access this site.
• http://localhost:8080/persons allows to access the person resources available through the service.

Have a look into the implementation to understand which endpoints are available in addition.

Most important annotations and classes

A collection of the most important annotations and classes that are necessary to implement this use case.

• @GetMapping
• @PostMapping
• @DeleteMapping
• @RequestMapping
• @RestController
• @WebMvcTest

Used frameworks

A collection of the mainly used frameworks in this project. There are more, but they are not that present inside the main use case, therefore they are not listed here.

• Spring Web
• Spring Boot

Additional guides

The following guides illustrate how to implement this and related use cases.

• Building a RESTful Web Service
• Serving Web Content with Spring MVC
• Building REST services with Spring

License

This code is open source software licensed under the Apache 2.0 License.