Embed Size (px)
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.org
Citation preview
LAZYDOCA framework for the automatic generation of REST API documentation
SOME BUZZWORDS
WHY LAZYDOC?
Documenting your REST API is often no fun
WHY LAZYDOC?
The person who documents is not always the developer
WHY LAZYDOC?
The documentation can be out-dated very soon
WHY LAZYDOC?
The documentation is often just done in Word…
WHY LAZYDOC?
… or maybe in Swagger …
WHY LAZYDOC?
… or with Docbook in HTML or PDF format …
WHY LAZYDOC?
… but what if you want to support all those formats?
WHAT IS LAZYDOC
Modular Framework to parse source code and produce documentation
WHAT IS LAZYDOCStructure
Parser
ParserParser
Printer
ReporterConfig
WHAT IS LAZYDOC
Capability to support different parser
Parameter
Operation
SubDomain
WHAT IS LAZYDOCData model
Domain Error
DataType
Property
WHAT IS LAZYDOC
Annotation based documentation close to the source
WHAT IS LAZYDOCAnnotation Overview
SubDomainDescription
DomainDescription
OperationDescription
ParameterDescription
Parameter
ResponseDescription
ExternalDocumentation
IgnoreForDocumentation
PropertyDescription!
Sample!
WHAT IS LAZYDOC
Print in different formats
WHAT IS LAZYDOC
Report about documentation coverage
WHAT IS LAZYDOC
Part of the build process
LIVE DEMO
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
