io.inversion.action.openapi

Class OpenAPIAction<A extends OpenAPIAction>

java.lang.Object

io.inversion.Rule<A>

io.inversion.Action<A>

io.inversion.action.misc.FileAction<A>

io.inversion.action.openapi.OpenAPIAction<A>

All Implemented Interfaces:

OpenAPIWriter<A>, java.lang.Comparable<A>

public class OpenAPIAction<A extends OpenAPIAction>
extends FileAction<A>

https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Getting-started https://javadoc.io/doc/io.swagger.core.v3/swagger-models/latest/index.html https://mvnrepository.com/artifact/io.swagger.core.v3 https://mvnrepository.com/artifact/io.swagger.core.v3/swagger-core https://swagger.io/tools/open-source/open-source-integrations/ https://github.com/swagger-api/swagger-core https://swagger.io/specification/

Nested Class Summary

Nested classes/interfaces inherited from class io.inversion.Rule

Rule.RuleMatcher

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	copyToOutputDirInDevMode
protected java.lang.String	outputBaseDir
protected java.lang.String	patchesBaseDir
protected java.lang.String	templateBaseDir
protected OpenAPISpecWriter	writer

Fields inherited from class io.inversion.action.misc.FileAction

baseDir, files

Fields inherited from class io.inversion.Rule

ALL_METHODS, configMap, description, excludeMatchers, excludeOn, includeMatchers, includeOn, log, name, order, params

Constructor Summary

Constructors

Constructor and Description
OpenAPIAction()

Method Summary

Modifier and Type	Method and Description
void	doGet(Request req, Response res) Handle an HTTP GET.
io.inversion.json.JSList	findPatches(Request req)
java.lang.String	findTemplate(Request req)
io.swagger.v3.oas.models.OpenAPI	generateOpenApi(Request req)
java.lang.String	getOutputBaseDir()
java.lang.String	getPatchesBaseDir()
java.lang.String	getTemplateBaseDir()
OpenAPISpecWriter	getWriter()
void	serveOpenApi(Request req, Response res, java.lang.String file)
OpenAPIAction	withOutputBaseDir(java.lang.String outputBaseDir)
OpenAPIAction	withPatchesBaseDir(java.lang.String patchesBaseDir)
OpenAPIAction	withTemplateBaseDir(java.lang.String templateBaseDir)
OpenAPIAction	withWriter(OpenAPISpecWriter writer)
io.inversion.json.JSNode	writeOpenAPI(Request req, io.swagger.v3.oas.models.OpenAPI openApi) Override me to manually edit the OpenAPI pojo before it is serialized to JSON OR to edit the JSNode model after it has been serialized.

Methods inherited from class io.inversion.action.misc.FileAction

canServe, findStream, getBaseDir, getFiles, serveFile, serveFile, withBaseDir, withFiles

Methods inherited from class io.inversion.Action

configureOp, doDelete, doPatch, doPost, doPut, getFullIncludePaths, getIncludePaths, isDecoration, joinPaths, joinPaths0, run, run0, withDecoration

Methods inherited from class io.inversion.Rule

afterWiringComplete, checkLazyConfig, compareTo, doLazyConfig, getAllExcludePaths, getAllIncludeMethods, getAllIncludePaths, getDefaultIncludeMatchers, getDescription, getExcludeMatchers, getIncludeMatchers, getName, getOrder, getParams, match, match, matches, matches, toString, withDescription, withExcludeOn, withExcludeOn, withIncludeOn, withIncludeOn, withName, withOrder, withParam, withParams

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.inversion.action.openapi.OpenAPIWriter

addResponse, addResponse, beautifyTag, buildOperation, documentOpDelete, documentOperationSchema, documentOpFind, documentOpGet, documentOpPatch, documentOpPost, documentOpPut, documentOpRelated, documentParam, documentQueryParams, documentRequestSchema, documentResourceSchema, documentResponseSchema, findOp, getDescription, getSchemaRef, hasParam, hook_documentOp, newComponentRefSchema, newHrefSchema, newTypeSchema, removeReadOnlyProperties

Field Detail

templateBaseDir

protected java.lang.String templateBaseDir

patchesBaseDir

protected java.lang.String patchesBaseDir

outputBaseDir

protected java.lang.String outputBaseDir

writer

protected OpenAPISpecWriter writer

copyToOutputDirInDevMode

protected boolean copyToOutputDirInDevMode

Constructor Detail

OpenAPIAction

public OpenAPIAction()

Method Detail

doGet

public void doGet(Request req,
                  Response res)
           throws ApiException

Description copied from class: Action

Handle an HTTP GET.

Override run() to handle all requests or override this method with your business logic specifically for a GET request

Overrides:

doGet in class FileAction<A extends OpenAPIAction>

Parameters:

req - the request to run

res - the response to populate

Throws:

ApiException

serveOpenApi

public void serveOpenApi(Request req,
                         Response res,
                         java.lang.String file)

writeOpenAPI

public io.inversion.json.JSNode writeOpenAPI(Request req,
                                             io.swagger.v3.oas.models.OpenAPI openApi)

Override me to manually edit the OpenAPI pojo before it is serialized to JSON OR to edit the JSNode model after it has been serialized.

Parameters:

openApi -

Returns:

the JSNode representation of the OpenAPI JSON.

generateOpenApi

public io.swagger.v3.oas.models.OpenAPI generateOpenApi(Request req)

findTemplate

public java.lang.String findTemplate(Request req)

findPatches

public io.inversion.json.JSList findPatches(Request req)

getTemplateBaseDir

public java.lang.String getTemplateBaseDir()

withTemplateBaseDir

public OpenAPIAction withTemplateBaseDir(java.lang.String templateBaseDir)

getPatchesBaseDir

public java.lang.String getPatchesBaseDir()

withPatchesBaseDir

public OpenAPIAction withPatchesBaseDir(java.lang.String patchesBaseDir)

getOutputBaseDir

public java.lang.String getOutputBaseDir()

withOutputBaseDir

public OpenAPIAction withOutputBaseDir(java.lang.String outputBaseDir)

getWriter

public OpenAPISpecWriter getWriter()

withWriter

public OpenAPIAction withWriter(OpenAPISpecWriter writer)