SQL FaaS API manual

SQL FaaS API exposes the following endpoints:

• URL

  • http://www.gudusoft.com/format.php

• Method

  • POST

• Content-Type

  • application/x-www-form-urlencoded

• Request parameters

  Name	Description
  rqst_input_sql	Required, String. SQL string need to be formatted.
  rqst_db_vendor	Optional, String. SQL from this database, [available value](https://github.com/sqlparser/sql-pretty-printer/wiki/SQL-DB-Vendor)
  rqst_output_fmt	Optional, String. output type of formatted SQL, [available value](SQL-Output-format)
  rqst_formatOptions	Optional, String of json data. options used to control format style, [available value](http://www.gudusoft.com/format_option_sample.json), [Detailed explanation](SQL-Coding-Standard-and-Guideline)
  rqst_isf_client	Optional, String. Name of client who make this request.
  rqst_user_id	Optional, String. User who make this request.

• Response parameters

  Name	Description
  rspn_formatted_sql	String. Formatted SQL string.
  rspn_output_fmt	string, output type of formatted SQL, [available value](SQL-Output-format)
  rspn_parse_sql_status	integer. this value should be 0, otherwise, SQL doesn't formatted correctly.
  rspn_parse_sql_message	if rspn_parse_sql_status is not 0, then this is the detailed message.
  rspn_db_vendor	string, this sql is recognized from this database.
  rspn_http_status	Integer, 200 means everything works fine. 2xx means sql formatted correctly, but there maybe something wrong when processing this sql. 500 means internal server error.

SQL FaaS Home