Модуль ngx_http_xslt_module

Пример конфигурации
Директивы
xml_entities
xslt_last_modified
xslt_param
xslt_string_param
xslt_stylesheet
xslt_types

Модуль ngx_http_xslt_module (0.7.8+) — это фильтр, преобразующий XML-ответы с использованием одного или нескольких XSLT-стилей.

Этот модуль не включён по умолчанию, его необходимо включить с помощью параметра конфигурации --with-http_xslt_module.

Данному модулю необходимы библиотеки libxml2 и libxslt.

Пример конфигурации

location / {
    xml_entities    /site/dtd/entities.dtd;
    xslt_stylesheet /site/xslt/one.xslt param=value;
    xslt_stylesheet /site/xslt/two.xslt;
}

Директивы

Синтаксис:	`xml_entities path;`
Значение по умолчанию:	—
Контекст:	`http`, `server`, `location`

Указывает файл DTD, который объявляет символьные сущности. Этот файл компилируется на стадии конфигурации. По техническим причинам модуль не может использовать внешний подмножество, объявленное в обрабатываемом XML, поэтому оно игнорируется, и вместо него используется специально определённый файл. Этот файл не должен описывать структуру XML. Достаточно объявить только необходимые символьные сущности, например:

<!ENTITY nbsp "&#xa0;">

Синтаксис:	`xslt_last_modified on \| off;`
Значение по умолчанию:	`xslt_last_modified off;`
Контекст:	`http`, `server`, `location`

Эта директива появилась в версии 1.5.1.

Позволяет сохранить поле заголовка «Last-Modified» из исходного ответа во время преобразований XSLT для облегчения кеширования ответа.

По умолчанию поле заголовка удаляется, так как содержимое ответа изменяется во время преобразований и может содержать динамически сгенерированные элементы или части, которые изменяются независимо от исходного ответа.

Синтаксис:	`xslt_param parameter value;`
Значение по умолчанию:	—
Контекст:	`http`, `server`, `location`

Эта директива появилась в версии 1.1.18.

Определяет параметры для XSLT-стилей. value обрабатывается как выражение XPath. value может содержать переменные. Для передачи строкового значения в стиль можно использовать директиву xslt_string_param.

Может быть несколько xslt_param директив. Эти директивы наследуются с предыдущего уровня конфигурации, только если на текущем уровне не определены директивы xslt_param и xslt_string_param.

Синтаксис:	`xslt_string_param parameter value;`
Значение по умолчанию:	—
Контекст:	`http`, `server`, `location`

Эта директива появилась в версии 1.1.18.

Определяет строковые параметры для XSLT-стилей. Выражения XPath в value не интерпретируются. value может содержать переменные.

Может быть несколько xslt_string_param директив. Эти директивы наследуются с предыдущего уровня конфигурации, только если на текущем уровне не определены директивы xslt_param и xslt_string_param.

Синтаксис:	`xslt_stylesheet stylesheet [parameter=value ...];`
Значение по умолчанию:	—
Контекст:	`location`

Определяет XSLT-стиль и его необязательные параметры. Стиль компилируется на стадии конфигурации.

Параметры можно указать по отдельности или сгруппировать в одной строке, используя разделитель “:”. Если параметр содержит символ “:”, он должен быть экранирован как “%3A”. Также libxslt требует заключать параметры, содержащие не буквенно-цифровые символы, в одинарные или двойные кавычки, например:

param1='http%3A//www.example.com':param2=value2

Параметры описания могут содержать переменные, например, вся строка параметров может быть взята из одной переменной:

location / {
    xslt_stylesheet /site/xslt/one.xslt
                    $arg_xslt_params
                    param1='$value1':param2=value2
                    param3=value3;
}

Можно указать несколько стилей. Они будут применяться последовательно в указанном порядке.

Синтаксис:	`xslt_types mime-type ...;`
Значение по умолчанию:	`xslt_types text/xml;`
Контекст:	`http`, `server`, `location`

Включает преобразования в ответах со специфицированными MIME-типами в дополнение к “text/xml”. Специальное значение “*” соответствует любому MIME-типу (0.8.29). Если результат преобразования — HTML-ответ, его MIME-тип изменяется на “text/html”.

© 2002-2021 Igor Sysoev
© 2011-2024 Nginx, Inc.
Licensed under the BSD License.
https://nginx.org/en/docs/http/ngx_http_xslt_module.html