A Spring Boot example app which showcases the way REST endpoints can be exposed using Springfox Swagger UI, in order to allow users to perform CRUD operations on a remote MySQL database. DTOs are used in order to encapsulate certain aspects of the data which is sent/received. The Tomcat server is embedded into Spring Boot.
For building and running the application you need:
Since this is a Spring Boot app, the Tomcat server is embedded and in order to run the app, simply create a new project, add all the files and make sure to point the application.properties file to a valid mysql server and provide valid credentials. Use the following Maven run configuration for running the app:
mvn spring-boot:runThe app uses Springfox Swagger UI in order to facilitate the operations performed on the database, allowing users to send GET/PUT/POST/ PATCH/DELETE operations directly from the browser, eliminating the need for a tool such as Postman. The Springfox suite of java libraries are all about automating the generation of machine and human readable specifications for JSON APIs written using the spring family of projects.
Springfox works by examining an application, once, at runtime to infer API semantics based on spring configurations, class structure and various compile time java Annotations.
DTOs (data transfer objects) are used to encapsulate data and therefore hide some elements of the object being sent/received to/from one subsystem of the application to another. One main advantage of DTOs are the fact that the data needed for transferring object can be greatly reduced.
Released under the Apache License 2.0. See the LICENSE file.