irfanundevli / springfox-swagger-demo

Spring Boot 2 RESTful API Documentation With SpringFox Swagger 2 Demo App

SpringFox Swagger 2 with Spring REST APIs Demo App

This project was bootstrapped with Spring Initializr.

Overview

Two different swagger documentations are generated:
1. Public APIs : A documentation for non-secured REST APIs 2. Secured APIs : A documentation for secured REST APIs with Basic Authentication

Quick Start

First run spring boot application
and open http://localhost:8080/swagger-ui.html in a browser. Try it out!

Use below username and password to authorize Secured APIS:
Username: admin
Password: password1

SpringFox Swagger2 Artifacts

This instance of Spring Initializr has been enhanced with the following SpringFox Swagger2 artifacts:

Artifact	Description
springfox-swagger2	Generates metadata for JSON APIs written using the spring family of projects
springfox-swagger-ui	The GUI displaying HTML documentation based on JSON input
springfox-bean-validators	Generates Swagger documentation based on JSR 303 (Bean Validation) annotations

Learn More

To learn SpringFox, check out the SpringFox documentation.