lazydoc wjax presentation
DESCRIPTION
The slides of the WJAX presentation of lazydoc. Lazydoc is a framework to parse source code for documentation and generate documentation artifacts for Swagger, DocBook, etc. See: http://lazydoc.orgTRANSCRIPT
![Page 1: Lazydoc WJAX Presentation](https://reader035.vdocument.in/reader035/viewer/2022081404/559e1b441a28abe95b8b466e/html5/thumbnails/1.jpg)
LAZYDOCA framework for the automatic generation of REST API documentation
![Page 2: Lazydoc WJAX Presentation](https://reader035.vdocument.in/reader035/viewer/2022081404/559e1b441a28abe95b8b466e/html5/thumbnails/2.jpg)
SOME BUZZWORDS
![Page 3: Lazydoc WJAX Presentation](https://reader035.vdocument.in/reader035/viewer/2022081404/559e1b441a28abe95b8b466e/html5/thumbnails/3.jpg)
WHY LAZYDOC?
Documenting your REST API is often no fun
![Page 4: Lazydoc WJAX Presentation](https://reader035.vdocument.in/reader035/viewer/2022081404/559e1b441a28abe95b8b466e/html5/thumbnails/4.jpg)
WHY LAZYDOC?
The person who documents is not always the developer
![Page 5: Lazydoc WJAX Presentation](https://reader035.vdocument.in/reader035/viewer/2022081404/559e1b441a28abe95b8b466e/html5/thumbnails/5.jpg)
WHY LAZYDOC?
The documentation can be out-dated very soon
![Page 6: Lazydoc WJAX Presentation](https://reader035.vdocument.in/reader035/viewer/2022081404/559e1b441a28abe95b8b466e/html5/thumbnails/6.jpg)
WHY LAZYDOC?
The documentation is often just done in Word…
![Page 7: Lazydoc WJAX Presentation](https://reader035.vdocument.in/reader035/viewer/2022081404/559e1b441a28abe95b8b466e/html5/thumbnails/7.jpg)
WHY LAZYDOC?
… or maybe in Swagger …
![Page 8: Lazydoc WJAX Presentation](https://reader035.vdocument.in/reader035/viewer/2022081404/559e1b441a28abe95b8b466e/html5/thumbnails/8.jpg)
WHY LAZYDOC?
… or with Docbook in HTML or PDF format …
![Page 9: Lazydoc WJAX Presentation](https://reader035.vdocument.in/reader035/viewer/2022081404/559e1b441a28abe95b8b466e/html5/thumbnails/9.jpg)
WHY LAZYDOC?
… but what if you want to support all those formats?
![Page 10: Lazydoc WJAX Presentation](https://reader035.vdocument.in/reader035/viewer/2022081404/559e1b441a28abe95b8b466e/html5/thumbnails/10.jpg)
WHAT IS LAZYDOC
Modular Framework to parse source code and produce documentation
![Page 11: Lazydoc WJAX Presentation](https://reader035.vdocument.in/reader035/viewer/2022081404/559e1b441a28abe95b8b466e/html5/thumbnails/11.jpg)
WHAT IS LAZYDOCStructure
Parser
ParserParser
Printer
ReporterConfig
![Page 12: Lazydoc WJAX Presentation](https://reader035.vdocument.in/reader035/viewer/2022081404/559e1b441a28abe95b8b466e/html5/thumbnails/12.jpg)
WHAT IS LAZYDOC
Capability to support different parser
![Page 13: Lazydoc WJAX Presentation](https://reader035.vdocument.in/reader035/viewer/2022081404/559e1b441a28abe95b8b466e/html5/thumbnails/13.jpg)
Parameter
Operation
SubDomain
WHAT IS LAZYDOCData model
Domain Error
DataType
Property
![Page 14: Lazydoc WJAX Presentation](https://reader035.vdocument.in/reader035/viewer/2022081404/559e1b441a28abe95b8b466e/html5/thumbnails/14.jpg)
WHAT IS LAZYDOC
Annotation based documentation close to the source
![Page 15: Lazydoc WJAX Presentation](https://reader035.vdocument.in/reader035/viewer/2022081404/559e1b441a28abe95b8b466e/html5/thumbnails/15.jpg)
WHAT IS LAZYDOCAnnotation Overview
SubDomainDescription
DomainDescription
OperationDescription
ParameterDescription
Parameter
ResponseDescription
ExternalDocumentation
IgnoreForDocumentation
PropertyDescription!
Sample!
![Page 16: Lazydoc WJAX Presentation](https://reader035.vdocument.in/reader035/viewer/2022081404/559e1b441a28abe95b8b466e/html5/thumbnails/16.jpg)
WHAT IS LAZYDOC
Print in different formats
![Page 17: Lazydoc WJAX Presentation](https://reader035.vdocument.in/reader035/viewer/2022081404/559e1b441a28abe95b8b466e/html5/thumbnails/17.jpg)
WHAT IS LAZYDOC
Report about documentation coverage
![Page 18: Lazydoc WJAX Presentation](https://reader035.vdocument.in/reader035/viewer/2022081404/559e1b441a28abe95b8b466e/html5/thumbnails/18.jpg)
WHAT IS LAZYDOC
Part of the build process
![Page 19: Lazydoc WJAX Presentation](https://reader035.vdocument.in/reader035/viewer/2022081404/559e1b441a28abe95b8b466e/html5/thumbnails/19.jpg)
LIVE DEMO
![Page 20: Lazydoc WJAX Presentation](https://reader035.vdocument.in/reader035/viewer/2022081404/559e1b441a28abe95b8b466e/html5/thumbnails/20.jpg)
LazydocGITHUB: https://github.com/lazydoc/lazydocWWW: http://lazydoc.orgMAVEN: <dependency> <groupId>org.lazydoc</groupId> <artifactId>lazydoc</artifactId> <version>1.0.0-SNAPSHOT</version> </dependency>
EMAIL: [email protected]
WWW: https://internet-business-suite.de