https://github.com/mdecker-mobilecomputing/java_restapi_springboot
Java application with "Spring Boot" that shows how to implement an REST-API.
https://github.com/mdecker-mobilecomputing/java_restapi_springboot
docker rest-api spring-boot
Last synced: about 2 months ago
JSON representation
Java application with "Spring Boot" that shows how to implement an REST-API.
- Host: GitHub
- URL: https://github.com/mdecker-mobilecomputing/java_restapi_springboot
- Owner: MDecker-MobileComputing
- License: bsd-3-clause
- Created: 2019-06-26T10:37:55.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-12-17T15:07:01.000Z (over 2 years ago)
- Last Synced: 2025-01-05T21:09:09.805Z (over 1 year ago)
- Topics: docker, rest-api, spring-boot
- Language: Java
- Homepage:
- Size: 215 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Rest-API with Spring Boot #
This repository contains a small [Spring Boot](https://spring.io/projects/spring-boot) application that shows how to implement a basic REST API.
Additional information concerning this application can be found on [the Wiki pages for this repository](https://github.com/MDecker-MobileComputing/Java_RestApi_SpringBoot/wiki), but these pages are in German only.
See [this repository](https://github.com/MDecker-MobileComputing/Java_RestAPI_BmiBerechnung/) for another Java application that implements a REST API, but not with *Spring Boot*.
----
## Running the application ##
To start the application (i.e. to start the web server) you have several options:
* On the command line (you need to have installed [Apache Maven](https://maven.apache.org/index.html)):
* Run script `maven_run.bat` in Window's *cmd.exe* ("DOS Box").
* Enter the following command (starts goal `run` of plugin `spring-boot`):
> mvn spring-boot:run
You can also generate a so called **Fat Jar** by running script `mvn_package.bat`.
This should produce a file with suffix `jar` in folder `target/`.
This file contains all required dependencies (that's why is called "fat") and can be executed by a command like the following one:
java -jar restapidemo-0.0.1-SNAPSHOT.jar
See [this page in the Wiki for this repository](https://github.com/MDecker-MobileComputing/Java_RestApi_SpringBoot/wiki/Maven-in-Eclipse)
on how to define a *Run Configuration* for running Maven goal `spring-boot:run` in **Eclipse IDE**.
----
## JavaDoc ##
Execute script `maven_javadoc.bat` in Window's *cmd.exe*; the output files are written to folder `target/site/apidocs`.
----
## License ##
See the [LICENSE file](LICENSE.md) for license rights and limitations (BSD 3-Clause License).
See libraries and frameworks used as dependencies (see file `pom.xml`) have their own licenses.