Package org.plyct.plyex.docgen

Class DocGen

java.lang.Object

org.plyct.plyex.docgen.DocGen

public class DocGen
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
DocGen(PlyexOptions options)

Method Summary

Modifier and Type	Method	Description
protected void	addCodeSamples(PlyMethod plyMethod, OpenApi.Operation operation, JsonSchemaType schemaType, java.lang.Object requestExample, java.lang.Object responseExample)
protected void	addExamples(PlyMethod plyMethod, OpenApi.Operation operation)
DocGen	addMissingOperations()
OpenApi	augment(OpenApi openApi)
OpenApi	augment(OpenApi openApi, java.util.List<PlyMethod> plyMethods)
OpenApi	doAugment(OpenApi openApi, java.util.List<PlyMethod> plyMethods)
protected java.lang.Object	example(Endpoint endpoint, java.lang.String example, boolean isResponse)
DocGen	examplesFromActual()
java.lang.String	getOpenApi()
java.lang.String	getPlugin()
protected java.util.List<PlyMethod>	getPlyMethods()
java.lang.String	getRoot()
java.util.List<java.lang.String>	getSources()
boolean	isAddMissingOperations()
boolean	isExamplesFromActual()
boolean	isOverwriteExistingMeta()
protected OpenApi.Operation	newOperation(PlyMethod plyMethod)
DocGen	openApi(java.lang.String openApi)
DocGen	overwriteExistingMeta()
DocGen	plugin(java.lang.String plugin)
DocGen	root(java.lang.String root)
void	run()
DocGen	sources(java.util.List<java.lang.String> sources)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocGen

public DocGen(PlyexOptions options)

Method Detail

getRoot

public java.lang.String getRoot()

root

public DocGen root(java.lang.String root)

getSources

public java.util.List<java.lang.String> getSources()

sources

public DocGen sources(java.util.List<java.lang.String> sources)

getPlugin

public java.lang.String getPlugin()

plugin

public DocGen plugin(java.lang.String plugin)

isAddMissingOperations

public boolean isAddMissingOperations()

addMissingOperations

public DocGen addMissingOperations()

isOverwriteExistingMeta

public boolean isOverwriteExistingMeta()

overwriteExistingMeta

public DocGen overwriteExistingMeta()

isExamplesFromActual

public boolean isExamplesFromActual()

examplesFromActual

public DocGen examplesFromActual()

getOpenApi

public java.lang.String getOpenApi()

openApi

public DocGen openApi(java.lang.String openApi)

run

public void run()
         throws java.io.IOException

Throws:

java.io.IOException

augment

public OpenApi augment(OpenApi openApi)
                throws DocGenException

Throws:

DocGenException

augment

public OpenApi augment(OpenApi openApi,
                       java.util.List<PlyMethod> plyMethods)
                throws DocGenException

Throws:

DocGenException

doAugment

public OpenApi doAugment(OpenApi openApi,
                         java.util.List<PlyMethod> plyMethods)

newOperation

protected OpenApi.Operation newOperation(PlyMethod plyMethod)

addExamples

protected void addExamples(PlyMethod plyMethod,
                           OpenApi.Operation operation)

example

protected java.lang.Object example(Endpoint endpoint,
                                   java.lang.String example,
                                   boolean isResponse)

addCodeSamples

protected void addCodeSamples(PlyMethod plyMethod,
                              OpenApi.Operation operation,
                              JsonSchemaType schemaType,
                              java.lang.Object requestExample,
                              java.lang.Object responseExample)
                       throws java.io.IOException

Throws:

java.io.IOException

getPlyMethods

protected java.util.List<PlyMethod> getPlyMethods()
                                           throws DocGenException

Throws:

DocGenException