如何浏览 SQL Anywhere HTTP Web 服务器

Web 服务的命名和设计定义了可用的 URL 名称。每个 Web 服务都提供了它自己的 Web 内容集。通常这种内容都是由数据库中的自定义函数和过程生成的，不过内容也可以由指定 SQL 语句的 URL 生成。还可以换种方式，或两者结合，可以定义 root Web 服务，它可以处理所有无指定服务处理的 HTTP 请求。root Web 服务通常会检查请求的 URL 和标头来决定如何处理该请求。

资源，如通过 HTTP 或安全 HTTPS 请求可用的 html 内容，由 URL 唯一地指定。本节将说明如何在 Web 浏览器中设置 URL 语法的格式，以便访问 SQL Anywhere HTTP Web 服务器上定义的 Web 服务。

注意

本节中的信息适用于使用通用 HTTP Web 服务类型，如 RAW、XML 和 HTML，以及使用 DISH 服务的 HTTP Web 服务器。不能使用浏览器来发出 SOAP 请求。JSON 服务返回结果集，供使用 AJAX 的 Web 服务应用程序消耗。

语法

{http|https}://host-name[:port-number][/dbn]/service-name[/path-name|?url-query]

参数

host-name 和 port-number 指定 Web 服务器的位置，而在端口号未定义为缺省 HTTP 或 HTTPS 端口号时也可以指定端口号，但不是必须的。host-name 可以是运行 Web 服务器的计算机 IP 地址。port-number 必须与启动 Web 服务器时使用的端口号匹配。
请参见-xs 数据库服务器选项和ServerPort (PORT) 协议选项。
dbn 指定数据库名称。此数据库必须在 Web 服务器上运行，并且含有 Web 服务。
如果 Web 服务器只运行了一个数据库，或者如果数据库名指定予给定的 HTTP/HTTPS 协议选项监听者，则不需要指定 dbn。

请参见-xs 数据库服务器选项和DatabaseName (DBN) 协议选项。
service-name 指定要访问的 Web 服务的名称。此 Web 服务必须存在于 dbn 指定的数据库中。创建和变更 Web 服务的时候允许使用斜线字符 ( / )，因此它们可以用在 service-name 中。SQL Anywhere 会将 URL 的其余部分与定义的服务进行匹配。
如果未指定 service-name 而定义了 root Web 服务，客户端请求将被处理。如果服务器无法标识适用的服务来处理请求，将会返回 404 未找到 错误。副作用是，如果 root Web 服务不存在而无法根据 URL 条件来处理请求，它将负责产生 404 Not Found 错误。

path-name 解析服务名称后，余下的斜线隔开的路径可以用 Web 服务过程访问。如果服务是用 URL ON 创建的，使用指定的 URL HTTP 变量就可以访问整个路径。如果服务是用 URL ELEMENTS 创建的，使用指定的 HTTP 变量 URL1 至 URL10 就可以访问每个路径元素。

路径元素变量可以定义为服务语句定义的参数声明中的主机变量。作为上述方法的替代或补充，在存储函数内使用 HTTP_VARIABLE 函数调用也可以访问 HTTP 变量。

下例将说明创建 Web 服务所用的 SQL 语句，其 URL 子句设置为 ELEMENTS：

CREATE SERVICE TestWebService
    TYPE 'HTML'
    URL ELEMENTS
    AUTHORIZATION OFF
    USER DBA 
    AS CALL TestProcedure ( :url1, :url2 );

此 TestWebService Web 服务调用一过程，该过程显式地引用了 url1 与 url2 主机变量。

假设 TestWebService 在 localhost 上的 demo 数据库上通过缺省端口运行，可以用以下 URL 来访问该 Web 服务：

http://localhost/demo/TestWebService/Assignment1/Assignment2/Assignment3

该 URL 可以访问 TestWebService，此服务运行 TestProcedure，将值 Assignment1 指派给 url1，并将值 Assignment2 指派给 url2。（可选步骤）TestProcedure 能通过 HTTP_VARIABLE 函数访问其它路径元素。例如，HTTP_VARIABLE( 'url3' ) 函数调用返回 Assignment3。

有关 URL ELEMENTS 和基于 URL 的变量的详细信息，请参见CREATE SERVICE 语句 [HTTP Web 服务]。

url-query HTTP GET 请求可能会跟在路径后面，此路径带有指定 HTTP 变量的查询组件。类似地，使用标准 application/x-www-form-urlencoded Content-Type 的 POST 请求主体可以在请求主体内部传递 HTTP 变量。在这两种情况下，HTTP 变量都以名称/值对的形式传递，其中变量名用等号与其值隔开。变量用 & 符号隔开。

HTTP 变量可以在服务语句的参数列表中作为主机变量显式声明，也可以在服务语句的存储过程中用 HTTP_VARIABLE 函数访问。

例如，以下 SQL 语句将创建需要两个主机变量的 Web 服务。主机变量用冒号 (:) 作为前缀来标识。

CREATE SERVICE ShowSalesOrderDetail
    TYPE 'HTML'
    URL OFF
    AUTHORIZATION OFF
    USER DBA 
    AS CALL ShowSalesOrderDetail( :customer_id, :product_id );

假设 ShowSalesOrderDetail 在 localhost 上的演示数据库上通过缺省端口运行，可以用以下 URL 来访问该 Web 服务：

http://localhost/demo/ShowSalesOrderDetail?customer_id=101&product_id=300

该 URL 可以访问 ShowSalesOrderDetail，将值 101 指派给 customer_id，并将值 300 指派给 product_id。输出结果将以 HTML 格式在 Web 浏览器中显示。

注释

要求连接到服务器时，Web 浏览器将提示输入用户名和口令。随后，浏览器 base64 在 Authorization 请求标头中对用户输入编码，并重新发送请求。

如果 Web 服务 URL 子句设置为 ON 或 ELEMENTS，path-name 和 url-query 的 URL 语法属性可同时使用，从而可使用几种不同格式设置选项的其中一个便能访问 Web 服务。如果同时使用这些语法属性，path-name 格式必须首先使用，后跟 url-query 格式。

在下例中，此 SQL 语句将创建一个 Web 服务，其中 URL 子句设置为 ON，定义了 url 变量：

CREATE SERVICE ShowSalesOrderDetail
    TYPE 'HTML'
    URL ON
    AUTHORIZATION OFF
    USER DBA 
    AS CALL ShowSalesOrderDetail( :product_id, :url );

下面列出的是可接受的能够指派值 101 给 url 并指派值 300 给 product_id 的示例 URL：

http://localhost:80/demo/ShowSalesOrderDetail2/101?product_id=300
http://localhost:80/demo/ShowSalesOrderDetail2?url=101&product_id=300
http://localhost:80/demo/ShowSalesOrderDetail2?product_id=300&url=101

如果在 path-name 和 url-query 的上下文中一个主机变量名被多次指派，则最后的指派始终优先。例如，以下示例 URL 将指派值 101 给 url，并指派值 300 给 product_id：

http://localhost:80/demo/ShowSalesOrderDetail2/302?url=101&product_id=300
http://localhost:80/demo/ShowSalesOrderDetail2/String?product_id=300&url=101

另请参见

示例

以下 URL 语法用于访问名为 gallery_image 的 Web 服务，该服务在本地 HTTP 服务器上名为 demo 的数据库中通过缺省端口运行。假设 gallery_image 服务用 URL ON 来定义：

http://localhost/demo/gallery_image/sunset.jpg

该 URL 看似要从传统 Web 服务器的目录中请求图形文件，但它却指定 sunset.jpg 为 HTTP Web 服务器的输入参数来访问 gallery_image 服务。

以下 SQL 语句将说明如何在 HTTP 服务器上定义 gallery 服务来实现此行为：

CREATE SERVICE gallery_image
    TYPE 'RAW'
    URL ON
    AUTHORIZATION OFF
    USER DBA 
    AS CALL gallery_image ( :url );

gallery_image 服务调用一个同名的过程，传递客户端提供的 URL。有关实现可被此 Web 服务定义访问的 gallery_image 过程的示例，请参见 %SQLANYSAMP16%\SQLAnywhere\HTTP\gallery.sql。

使用DocCommentXchange讨论此页。