org.apache.flink.docs.rest

Class SqlGatewayRestAPIDocGenerator

java.lang.Object

org.apache.flink.docs.rest.SqlGatewayRestAPIDocGenerator

public class SqlGatewayRestAPIDocGenerator
extends Object

Generator for the Sql Gateway Rest API documentation.

One HTML file is generated for each RestServerEndpoint implementation that can be embedded into .md files using {% include ${generated.docs.dir}/file.html %}. Each file contains a series of HTML tables, one for each REST call.

The generated table for each REST call looks like this:

 ----------------------------------------------------------
 | URL                                                    |
 ----------------------------------------------------------
 | Verb: verb (GET|POST|...) | Response code: responseCode|
 ----------------------------------------------------------
 | Path parameters (if any are defined)                   |
 ----------------------------------------------------------
 |   - parameterName: description                         |
 |   ...                                                  |
 ----------------------------------------------------------
 | Query parameters (if any are defined)                  |
 ----------------------------------------------------------
 |   - parameterName (requisiteness): description         |
 |   ...                                                  |
 ----------------------------------------------------------
 | Request json schema (a collapsible "Request" button)   |
 ----------------------------------------------------------
 | Response json schema (a collapsible "Response" button) |
 ----------------------------------------------------------
 

Constructor Summary

Constructors

Constructor and Description
SqlGatewayRestAPIDocGenerator()

Method Summary

Modifier and Type	Method and Description
static void	main(String[] args) Generates the Sql Gateway REST API documentation.

Methods inherited from class java.lang.Object

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

Constructor Detail

SqlGatewayRestAPIDocGenerator

public SqlGatewayRestAPIDocGenerator()

Method Detail

main

public static void main(String[] args)
                 throws IOException,
                        ConfigurationException

Generates the Sql Gateway REST API documentation.

Parameters:

args - args[0] contains the directory into which the generated files are placed

Throws:

IOException - if any file operation failed

ConfigurationException