Skip to content

Spring Boot REST API Documentation with Swagger using SpringFox.

Notifications You must be signed in to change notification settings

Albatross-Cyber/Spring-REST

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Spring-REST

Spring Boot REST API Documentation with Swagger using SpringFox.

This is a simple RESTful CRUD (Create Read Update Delete) application providing set of endpoints for Creating, Retrieving, Updating and Deleting of employees saved in MySQL database.

Usage

An application expose 5 REST endpoints for Employee entity and they are:

  • GET {baseURL}/v2/employees - lists all Employees (as Json array),
  • GET {baseURL}/v2/employees/{id} - gets single Employee (as Json) by its {id},
  • POST {baseURL}/v2/employees - creates a new Employee which is passed in the BODY of the request,
  • PUT {baseURL}/v2/employees/{id} - updates an existing Employee (with an {id}) passed in the body of the request,
  • DELETE {baseURL}/v2/employees/{id}- deletes an existing Employee by its {id}.

If you run this application locally the {baseUrl} would be http://localhost:8080.

All available endpoints are listed on Swagger UI page which can be entered, when application is running, under http://localhost:8080/swagger-ui.html URL.

image

Other Useful Links

About

Spring Boot REST API Documentation with Swagger using SpringFox.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages