README.md

yaml-doc-tool

Tool for auto documentation of yaml / openapi

Quickstart (build)

mvn clean install -P singlepackage		

Quickstart (mode: single):

java -jar dist-yaml-doc-tool-*.jar --input-yaml [path-to-openapi] \
										--output-file [output-file] \
										--language [language] \
										--labels-override [path-to-labels-properties]

example :

java -jar dist-yaml-doc-tool-*.jar --input-yaml sample.yaml --output-file sample.pdf --language it

output-file
currently supported extensions : pdf, xlsx, xml, fo

language
currently supported languages : it, en

labels-overrides
path to alternate labels properties currently supported labels are available in : src/main/resources/lang/label.properties

maven plugin
A Maven Plugin is also available.

Quickstart (mode: config):

java -jar dist-yaml-doc-tool-*.jar 		--mode [config] \
										--config-path [path-to-config] \
										--id-catalog [id-catalog-in-config]

config-path
path to configuration (see sample)

id-catalog
id of the catalog in config to use

Quickstart (mode: check-model):

Node : the type to check need to be in classpath.

java -jar dist-yaml-doc-tool-*.jar 		--mode [check-model] \
										--input-yaml [path-to-openapi] \
										--output-file [output-file] \
										--check-type [java type to check] \
										--check-schema [openapi schema to check]
										--version [model-version]

Model version info (param "version")

Version 0 - legacy version (up to 1.0.0 excluded)

Version 1

handling handling of constraints OpenAPI data types

• minLength
• maxLength
• minimum
• maximum