bootique-examples / bootique-swagger-examples

Demo for bootique-swagger module

bootique-swagger-demo

A few sample apps demonstrating how to use Bootique Swagger to document REST APIs. The main example is bootique-swagger-openapi3-demo that demonstrates the use of OpenAPI.

You can find different versions of framework in use at

• 2.x

Prerequisites

• Java 11 or newer.
• Apache Maven.

Build

git clone https://github.com/bootique-examples/bootique-swagger-demo.git
cd bootique-swagger-demo
mvn package

Run

Enter the following to launch application with default url to swagger.json:

java -jar bootique-swagger-openapi3-demo/target/bootique-swagger-openapi3-demo-*.jar --server

After launching the app, check the following URLs:

• Example REST API: http://127.0.0.1:8080/api
• Swagger Web console: http://127.0.0.1:8080/swagger-ui
• Swagger model as JSON: http://127.0.0.1:8080/openapi.json
• Swagger model as YAML: http://127.0.0.1:8080/openapi.yaml