Reduce your effort to create a manual API documentation. Now with SpringFox (Swagger plugin for Spring) you can easily generate the API documentation with several block of code. Hope this help!

1. Documenting Your Existing APIs:
By: Wiratama Paramasatya
API Documentation Made Easy with Swagger and
Springfox

2. AGENDA
Challenges and Problems
Introduction to Swagger and Springfox
Springfox’s Component
Simple Demo

3. CHALLENGES AND PROBLEMS1

4. CHALLENGES AND PROBLEMS
Backend Engineer Frontend Engineer
Communication
Source: Personal Experience

5. SOLUTION 1
Backend Engineer
Create
Frontend Engineer
THE SOLUTIVE
Source: Personal Experience

6. INTRODUCTION TO SWAGGER AND
SPRINGFOX
2

7. INTRODUCTION TO SWAGGER AND SPRINGFOX
Stabilized Workflow.
Restraint-Free Build.
Tried and Trusted.
Built with Swagger.
Represented in a single
JSON file.
Support for swagger-ui
SWAGGER: SPRINGFOX:

8. SPRINGFOX’S COMPONENT3

9. SPRINGFOX’S COMPONENT
Mandatory annotation:

10. SPRINGFOX’S COMPONENT
Mandatory bean declaration:

11. SPRINGFOX’S COMPONENT
Mandatory overriding method:

12. SPRINGFOX’S COMPONENT
Other optional annotation component:
@ApiModelProperty
@ApiIgnore
@ApiOperation
And many more...

13. SPRINGFOX’S COMPONENT
Usage example on MyMovo:

14. SIMPLE DEMO4

15. REFERENCES
https://swagger.io/
https://swagger.io/specification/
https://swagger.io/swagger-ui/
http://docs.swagger.io/swagger-core
http://springfox.github.io/springfox
https://github.com/springfox/springfox

16. “
Don’t stop when it hurts, Stop when you
are done!
Thanks!