Skip to content

Latest commit

 

History

History
64 lines (43 loc) · 1.28 KB

Readme.md

File metadata and controls

64 lines (43 loc) · 1.28 KB

Demo Spring Boot

Sample springboot REST application

Swagger REST API Documentation

Swagger API

Requirements

  • Maven
  • JDK 8

Build Tool

This project uses maven as the build and packaging tool

Building

mvn install javadoc:javadoc

Java Doc

after completing the above command the generated java doc will be under /target/site/apidocs/

Running

To start the server simply type from the root directory spring boot application uses http://localhost:9090

mvn spring-boot:run

Alternatively if you have Docker installed you can start the application in a docker container which exposes port 9090

./start.sh

Note: will start a clean build and regenerate the java docs

Testing

Postman

A Postman collection is included under /src/tes/resources folder.

cURL

Home controller command:

$ curl localhost:9090

Other commands

Each cURL command can be easily generated via the included Postman collection

  1. locate the right label titled: "Generate Code"
  2. From the resulting pop up "Generate Code Snippet" window, locate on the left side a combo box and choose cURL option.