com.google.api.server.spi.tools

Class GetOpenApiDocAction

java.lang.Object

com.google.appengine.tools.util.Action

com.google.api.server.spi.tools.EndpointsToolAction

com.google.api.server.spi.tools.GetOpenApiDocAction

public class GetOpenApiDocAction
extends EndpointsToolAction

Command to generate an OpenAPI document from annotated service classes.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.server.spi.tools.EndpointsToolAction

EndpointsToolAction.EndpointsOption

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LEGACY_NAME
static java.lang.String	NAME

Fields inherited from class com.google.api.server.spi.tools.EndpointsToolAction

OPTION_BASE_PATH_LONG, OPTION_BASE_PATH_SHORT, OPTION_BUILD_SYSTEM_LONG, OPTION_BUILD_SYSTEM_SHORT, OPTION_CLASS_PATH_LONG, OPTION_CLASS_PATH_SHORT, OPTION_DEBUG, OPTION_FORMAT_LONG, OPTION_FORMAT_SHORT, OPTION_HOSTNAME_LONG, OPTION_HOSTNAME_SHORT, OPTION_LANGUAGE_LONG, OPTION_LANGUAGE_SHORT, OPTION_OUTPUT_DIR_LONG, OPTION_OUTPUT_DIR_SHORT, OPTION_WAR_LONG, OPTION_WAR_SHORT

Fields inherited from class com.google.appengine.tools.util.Action

extraOptions, shortDescription

Constructor Summary

Constructors

Modifier	Constructor and Description
	GetOpenApiDocAction()
protected	GetOpenApiDocAction(java.lang.String alias, boolean displayHelp)

Method Summary

Modifier and Type	Method and Description
boolean	execute() Executes the command with the given arguments.
java.lang.String	genOpenApiDoc(java.net.URL[] classPath, java.lang.String outputFilePath, java.lang.String hostname, java.lang.String basePath, java.util.List<java.lang.String> serviceClassNames, boolean outputToDisk) Generates an OpenAPI document for an array of service classes.
java.lang.String	getUsageString() Returns a usage string for help output.

Methods inherited from class com.google.api.server.spi.tools.EndpointsToolAction

apply, computeClassPath, getBasePath, getBuildSystem, getClassPath, getDebug, getExampleString, getFormat, getHelpLines, getHostname, getLanguage, getOpenApiOutputPath, getOptionOrDefault, getOutputPath, getServiceClassNames, getWarOutputPath, getWarPath, isHelpDisplayNeeded, makeBasePathOption, makeBuildSystemOption, makeClassPathOption, makeDebugOption, makeFormatOption, makeHostnameOption, makeLanguageOption, makeOpenApiOutputOption, makeOutputOption, makeWarOption, makeWarOutputOption, setExampleString, setHelpDisplayNeeded

Methods inherited from class com.google.appengine.tools.util.Action

getArgs, getHelpString, getNames, getNameString, getOptions, getShortDescription, setArgs, setOptions, setShortDescription

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

LEGACY_NAME

public static final java.lang.String LEGACY_NAME

See Also:

Constant Field Values

Constructor Detail

GetOpenApiDocAction

public GetOpenApiDocAction()

GetOpenApiDocAction

protected GetOpenApiDocAction(java.lang.String alias,
                              boolean displayHelp)

Method Detail

getUsageString

public java.lang.String getUsageString()

Description copied from class: EndpointsToolAction

Returns a usage string for help output.

Specified by:

getUsageString in class EndpointsToolAction

execute

public boolean execute()
                throws java.lang.ClassNotFoundException,
                       java.io.IOException,
                       com.google.api.server.spi.config.ApiConfigException

Description copied from class: EndpointsToolAction

Executes the command with the given arguments.

Specified by:

execute in class EndpointsToolAction

Returns:

whether or not all required arguments were provided

Throws:

java.lang.ClassNotFoundException

java.io.IOException

com.google.api.server.spi.config.ApiConfigException

genOpenApiDoc

public java.lang.String genOpenApiDoc(java.net.URL[] classPath,
                                      java.lang.String outputFilePath,
                                      java.lang.String hostname,
                                      java.lang.String basePath,
                                      java.util.List<java.lang.String> serviceClassNames,
                                      boolean outputToDisk)
                               throws java.lang.ClassNotFoundException,
                                      java.io.IOException,
                                      com.google.api.server.spi.config.ApiConfigException

Generates an OpenAPI document for an array of service classes.

Parameters:

classPath - Class path to load service classes and their dependencies

outputFilePath - File to store the OpenAPI document in

hostname - The hostname to use for the OpenAPI document

basePath - The base path to use for the OpenAPI document, e.g. /_ah/api

serviceClassNames - Array of service class names of the API

outputToDisk - Iff true, outputs a openapi.json to disk.

Returns:

a single OpenAPI document representing all service classes.

Throws:

java.lang.ClassNotFoundException

java.io.IOException

com.google.api.server.spi.config.ApiConfigException