Let your REST API talk @java2days
0 likes318 views
This document discusses REST APIs and the benefits of using Swagger to generate documentation for REST APIs built with Spring MVC. It explains that REST and HTTP have been widely used for decades to power APIs. Swagger allows generating interactive API documentation from code comments directly in the Spring MVC codebase. The document then provides a hands-on example of using Springfox to integrate Swagger into a Spring MVC REST API project to automatically generate API documentation.
Let your REST API talk @java2days
- 1. Let your REST API talk Nikolay Petkov Service Center Manager @Proxiad
- 2. Whats inside ● Few words about REST ● Why Swagger? ● Swagger for Spring MVC = Springfox ● Hands on with sample app
- 3. Why REST? ● HTTP powers the net for decades ● Every major programing language has first class support for HTTP, both server and client side ● Browsers (understandably) and JavaScript speak HTTP fluently ● HTTP is features rich protocol, why get stacked to POST requests to carry payload ;-)
- 5. HTTP Methods
- 6. Status Codes
- 7. Why SWAGGER
- 10. What is Swagger ● Swagger specification - capabilities of the service description in JSON format ● Swagger UI – live documentation and playground ● Set of tools for many programming languages and frameworks ● Swagger codegen – language bindings for client and server code generation
- 11. Spring MVC & Swagger ● Spring MVC to build REST APIs ● Springfox to generate Swagger specification for REST APIs ● Swagger-UI to generate dynamic documentation and sandbox ● Dilip Krishnan and 50 more contributors to give you a hand :-)
- 12. Hands on example