Mercurial > hg > nginx-site

changeset 2175:cd4889fdcfa4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Moved njs HTTP and Stream API to a separate page.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 05 Jun 2018 18:22:00 +0300
parents 3b782a679237
children 95b406f1f347
files xml/en/GNUmakefile xml/en/docs/http/ngx_http_js_module.xml xml/en/docs/njs/njs_api.xml xml/en/docs/njs_about.xml xml/en/docs/stream/ngx_stream_js_module.xml xml/ru/GNUmakefile xml/ru/docs/http/ngx_http_js_module.xml xml/ru/docs/njs/njs_api.xml xml/ru/docs/njs_about.xml xml/ru/docs/stream/ngx_stream_js_module.xml
diffstat 10 files changed, 750 insertions(+), 500 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/GNUmakefile
+++ b/xml/en/GNUmakefile
@@ -124,6 +124,7 @@ REFS =									\
 		ngx_google_perftools_module				\
 		dev/development_guide					\
 		njs/njs_changes						\
+		njs/njs_api						\
 
 TOP =									\
 		download						\
--- a/xml/en/docs/http/ngx_http_js_module.xml
+++ b/xml/en/docs/http/ngx_http_js_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_http_js_module"
         link="/en/docs/http/ngx_http_js_module.html"
         lang="en"
-        rev="10">
+        rev="11">
 
 <section id="summary">
 
@@ -160,181 +160,11 @@ Sets an njs function for the specified v
 
 
 <section id="arguments" name="Request and Response Arguments">
-<para>
-Each HTTP njs handler receives two arguments, request and response.
-</para>
-
-<para>
-The request object has the following properties:
-<list type="tag">
-
-<tag-name><literal>uri</literal></tag-name>
-<tag-desc>
-current URI in a request, read-only
-</tag-desc>
-
-<tag-name><literal>method</literal></tag-name>
-<tag-desc>
-request method, read-only
-</tag-desc>
-
-<tag-name><literal>httpVersion</literal></tag-name>
-<tag-desc>
-HTTP version, read-only
-</tag-desc>
-
-<tag-name><literal>remoteAddress</literal></tag-name>
-<tag-desc>
-client address, read-only
-</tag-desc>
-
-<tag-name><literal>headers{}</literal></tag-name>
-<tag-desc>
-request headers object, read-only.
-<para>
-For example, the <literal>Header-Name</literal> header
-can be accessed with the syntax <literal>headers['Header-Name']</literal>
-or <literal>headers.Header_name</literal>
-</para>
-</tag-desc>
-
-<tag-name><literal>args{}</literal></tag-name>
-<tag-desc>
-request arguments object, read-only
-</tag-desc>
-
-<tag-name><literal>variables{}</literal></tag-name>
-<tag-desc>
-nginx variables object, read-only
-</tag-desc>
-
-<tag-name><literal>response</literal></tag-name>
-<tag-desc>
-the response object (0.2.0), read-only
-</tag-desc>
-</list>
-</para>
-
-<para>
-The request object has the following methods:
-<list type="tag">
-
-<tag-name><literal>log(<value>string</value>)</literal></tag-name>
-<tag-desc>
-writes a <literal>string</literal> to the error log
-on the <literal>info</literal> level of logging
-</tag-desc>
-
-<tag-name><literal>warn(<value>string</value>)</literal></tag-name>
-<tag-desc>
-writes a <literal>string</literal> to the error log
-on the <literal>warning</literal> level of logging (0.2.0)
-</tag-desc>
-
-<tag-name><literal>error(<value>string</value>)</literal></tag-name>
-<tag-desc>
-writes a <literal>string</literal> to the error log
-on the <literal>error</literal> level of logging (0.2.0)
-</tag-desc>
-
-<tag-name><literal>subrequest(<value>uri</value>[, <value>options</value>[,
-<value>callback</value>]])</literal></tag-name>
-<tag-desc>
-creates a subrequest with the given <literal>uri</literal> and
-<literal>options</literal>, and installs
-an optional completion <literal>callback</literal> (0.2.0).
 
 <para>
-If <literal>options</literal> is a string, then it
-holds the subrequest arguments string.
-Otherwise <literal>options</literal> is expected to be
-an object with the following keys:
-<list type="tag">
-<tag-name><literal>args</literal></tag-name>
-<tag-desc>arguments string</tag-desc>
-
-<tag-name><literal>body</literal></tag-name>
-<tag-desc>request body</tag-desc>
-
-<tag-name><literal>method</literal></tag-name>
-<tag-desc>HTTP method</tag-desc>
-</list>
-</para>
-
-<para>
-The <literal>callback</literal> receives a response object
-with the following properties:
-<literal>uri</literal>, <literal>method</literal>,
-<literal>status</literal>, <literal>contentType</literal>,
-<literal>contentLength</literal>, <literal>headers</literal>,
-<literal>args</literal>.
-These properties have the same meaning as the request object properties.
-Additionally, a reply object has the <literal>body</literal> property
-holding the subrequest response body
-and the <literal>parent</literal> property
-referencing the parent request object.
-</para>
-</tag-desc>
-</list>
-</para>
-
-<para>
-The response object has the following properties:
-<list type="tag">
-
-<tag-name><literal>status</literal></tag-name>
-<tag-desc>
-response status, writable
-</tag-desc>
-
-<tag-name><literal>headers{}</literal></tag-name>
-<tag-desc>
-response headers object
-</tag-desc>
-
-<tag-name><literal>contentType</literal></tag-name>
-<tag-desc>
-the response <header>Content-Type</header> header field value, writable
-</tag-desc>
-
-<tag-name><literal>contentLength</literal></tag-name>
-<tag-desc>
-the response <header>Content-Length</header> header field value, writable
-</tag-desc>
-</list>
-</para>
-
-<para>
-The response object has the following methods:
-<list type="tag">
-
-<tag-name><literal>sendHeader()</literal></tag-name>
-<tag-desc>
-sends the HTTP header to the client
-</tag-desc>
-
-<tag-name><literal>send(<value>string</value>)</literal></tag-name>
-<tag-desc>
-sends a part of the response body to the client
-</tag-desc>
-
-<tag-name><literal>finish()</literal></tag-name>
-<tag-desc>
-finishes sending a response to the client
-</tag-desc>
-
-<tag-name><literal>return(status[, string])</literal></tag-name>
-<tag-desc>
-sends
-the entire response with the specified <literal>status</literal> to the client
-(0.2.0)
-<para>
-It is possible to specify either a redirect URL
-(for codes 301, 302, 303, 307, and 308)
-or the response body text (for other codes) as the second argument.
-</para>
-</tag-desc>
-</list>
+Each HTTP njs handler receives two arguments,
+<link doc="../njs/njs_api.xml" id="http_request">request</link>
+and <link doc="../njs/njs_api.xml" id="http_response">response</link>.
 </para>
 
 </section>
new file mode 100644
--- /dev/null
+++ b/xml/en/docs/njs/njs_api.xml
@@ -0,0 +1,354 @@
+<?xml version="1.0"?>
+
+<!--
+  Copyright (C) Nginx, Inc.
+  -->
+
+<!DOCTYPE article SYSTEM "../../../../dtd/article.dtd">
+
+<article name="njs API"
+        link="/en/docs/njs/njs_api.html"
+        lang="en"
+        rev="1">
+
+<section id="summary">
+
+<para>
+<link doc="../njs_about.xml">njs</link> provides objects, methods and properties
+for extending nginx functionality.
+</para>
+
+</section>
+
+
+<section id="http" name="HTTP">
+
+<para>
+The <literal>HTTP</literal> objects are available only in the
+<link doc="../http/ngx_http_js_module.xml">ngx_http_js_module</link> module.
+</para>
+
+
+<section id="http_request" name="Request">
+
+<para>
+<list type="tag">
+
+<tag-name><literal>req.uri</literal></tag-name>
+<tag-desc>
+current URI in a request, read-only
+</tag-desc>
+
+<tag-name><literal>req.method</literal></tag-name>
+<tag-desc>
+request method, read-only
+</tag-desc>
+
+<tag-name><literal>req.httpVersion</literal></tag-name>
+<tag-desc>
+HTTP version, read-only
+</tag-desc>
+
+<tag-name><literal>req.remoteAddress</literal></tag-name>
+<tag-desc>
+client address, read-only
+</tag-desc>
+
+<tag-name><literal>req.headers{}</literal></tag-name>
+<tag-desc>
+request headers object, read-only.
+<para>
+For example, the <literal>Header-Name</literal> header
+can be accessed with the syntax <literal>headers['Header-Name']</literal>
+or <literal>headers.Header_name</literal>
+</para>
+</tag-desc>
+
+<tag-name><literal>req.args{}</literal></tag-name>
+<tag-desc>
+request arguments object, read-only
+</tag-desc>
+
+<tag-name><literal>request.variables{}</literal></tag-name>
+<tag-desc>
+nginx variables object, read-only
+</tag-desc>
+
+<tag-name><literal>req.response</literal></tag-name>
+<tag-desc>
+the <link id="http_response">response</link> object (0.2.0), read-only
+</tag-desc>
+
+<tag-name><literal>req.log(<value>string</value>)</literal></tag-name>
+<tag-desc>
+writes a <literal>string</literal> to the error log
+on the <literal>info</literal> level of logging
+</tag-desc>
+
+<tag-name><literal>req.warn(<value>string</value>)</literal></tag-name>
+<tag-desc>
+writes a <literal>string</literal> to the error log
+on the <literal>warning</literal> level of logging (0.2.0)
+</tag-desc>
+
+<tag-name><literal>req.error(<value>string</value>)</literal></tag-name>
+<tag-desc>
+writes a <literal>string</literal> to the error log
+on the <literal>error</literal> level of logging (0.2.0)
+</tag-desc>
+
+<tag-name id="subrequest"><literal>req.subrequest(<value>uri</value>[,
+<value>options</value>[, <value>callback</value>]])</literal></tag-name>
+<tag-desc>
+creates a subrequest with the given <literal>uri</literal> and
+<literal>options</literal>, and installs
+an optional completion <literal>callback</literal> (0.2.0).
+
+<para>
+If <literal>options</literal> is a string, then it
+holds the subrequest arguments string.
+Otherwise, <literal>options</literal> is expected to be
+an object with the following keys:
+
+<list type="tag">
+<tag-name><literal>args</literal></tag-name>
+<tag-desc>
+arguments string
+</tag-desc>
+
+<tag-name><literal>body</literal></tag-name>
+<tag-desc>
+request body
+</tag-desc>
+
+<tag-name><literal>method</literal></tag-name>
+<tag-desc>
+HTTP method
+</tag-desc>
+</list>
+</para>
+
+<para>
+The completion <literal>callback</literal>
+receives a <link id="http_reply_object">reply</link> object.
+</para>
+</tag-desc>
+
+</list>
+</para>
+
+</section>
+
+
+<section id="http_response" name="Response">
+
+<para>
+<list type="tag">
+
+<tag-name><literal>res.status</literal></tag-name>
+<tag-desc>
+response status, writable
+</tag-desc>
+
+<tag-name><literal>res.headers{}</literal></tag-name>
+<tag-desc>
+response headers object
+</tag-desc>
+
+<tag-name><literal>res.contentType</literal></tag-name>
+<tag-desc>
+the response <header>Content-Type</header> header field value, writable
+</tag-desc>
+
+<tag-name><literal>res.contentLength</literal></tag-name>
+<tag-desc>
+the response <header>Content-Length</header> header field value, writable
+</tag-desc>
+
+<tag-name><literal>res.sendHeader()</literal></tag-name>
+<tag-desc>
+sends the HTTP header to the client
+</tag-desc>
+
+<tag-name><literal>res.send(<value>string</value>)</literal></tag-name>
+<tag-desc>
+sends a part of the response body to the client
+</tag-desc>
+
+<tag-name><literal>res.finish()</literal></tag-name>
+<tag-desc>
+finishes sending a response to the client
+</tag-desc>
+
+<tag-name><literal>res.return(status[, string])</literal></tag-name>
+<tag-desc>
+sends
+the entire response with the specified <literal>status</literal> to the client
+(0.2.0)
+<para>
+It is possible to specify either a redirect URL
+(for codes 301, 302, 303, 307, and 308)
+or the response body text (for other codes) as the second argument
+</para>
+</tag-desc>
+
+</list>
+</para>
+
+</section>
+
+
+<section id="http_reply" name="Reply">
+
+<para>
+<list type="tag">
+
+<tag-name><literal>reply.uri</literal></tag-name>
+<tag-desc>
+current URI in a reply, read-only
+</tag-desc>
+
+<tag-name><literal>reply.method</literal></tag-name>
+<tag-desc>
+reply method, read-only
+</tag-desc>
+
+<tag-name><literal>reply.status</literal></tag-name>
+<tag-desc>
+reply status, writable
+</tag-desc>
+
+<tag-name><literal>reply.contentType</literal></tag-name>
+<tag-desc>
+the response <header>Content-Type</header> header field value, writable
+</tag-desc>
+
+<tag-name><literal>reply.contentLength</literal></tag-name>
+<tag-desc>
+the response <header>Content-Length</header> header field value, writable
+</tag-desc>
+
+<tag-name><literal>reply.headers{}</literal></tag-name>
+<tag-desc>
+reply headers object, read-only
+</tag-desc>
+
+</list>
+</para>
+
+<para>
+Additionally, the <literal>reply</literal> object has
+the following properties:
+
+<list type="tag">
+
+<tag-name><literal>reply.body</literal></tag-name>
+<tag-desc>
+holds the subrequest response body
+</tag-desc>
+
+<tag-name><literal>reply.parent</literal></tag-name>
+<tag-desc>
+references the parent request object
+</tag-desc>
+
+</list>
+</para>
+
+</section>
+
+</section>
+
+
+<section id="stream" name="Stream">
+
+<para>
+The <literal>stream</literal> objects are available only in the
+<link doc="../stream/ngx_stream_js_module.xml">ngx_stream_js_module</link>
+module.
+</para>
+
+
+<section id="stream_session" name="Session">
+
+<para>
+<list type="tag">
+
+<tag-name><literal>s.remoteAddress</literal></tag-name>
+<tag-desc>
+client address, read-only
+</tag-desc>
+
+<tag-name><literal>s.eof</literal></tag-name>
+<tag-desc>
+a boolean read-only property, true if the current buffer is the last buffer
+</tag-desc>
+
+<tag-name><literal>s.fromUpstream</literal></tag-name>
+<tag-desc>
+a boolean read-only property,
+true if the current buffer is from the upstream server to the client
+</tag-desc>
+
+<tag-name><literal>s.buffer</literal></tag-name>
+<tag-desc>
+the current buffer, writable
+</tag-desc>
+
+<tag-name><literal>s.variables{}</literal></tag-name>
+<tag-desc>
+nginx variables object, read-only
+</tag-desc>
+
+<tag-name><literal>s.OK</literal></tag-name>
+<tag-desc>
+the <literal>OK</literal> return code
+</tag-desc>
+
+<tag-name><literal>s.DECLINED</literal></tag-name>
+<tag-desc>
+the <literal>DECLINED</literal> return code
+</tag-desc>
+
+<tag-name><literal>s.AGAIN</literal></tag-name>
+<tag-desc>
+the <literal>AGAIN</literal> return code
+</tag-desc>
+
+<tag-name><literal>s.ERROR</literal></tag-name>
+<tag-desc>
+the <literal>ERROR</literal> return code
+</tag-desc>
+
+<tag-name><literal>s.ABORT</literal></tag-name>
+<tag-desc>
+the <literal>ABORT</literal> return code
+</tag-desc>
+
+<tag-name><literal>s.log(<value>string</value>)</literal></tag-name>
+<tag-desc>
+writes a sent <value>string</value> to the error log
+on the <literal>info</literal> level of logging
+</tag-desc>
+
+<tag-name><literal>s.warn(<value>string</value>)</literal></tag-name>
+<tag-desc>
+writes a sent <literal>string</literal> to the error log
+on the <literal>warning</literal> level of logging (0.2.0)
+</tag-desc>
+
+<tag-name><literal>s.error(<value>string</value>)</literal></tag-name>
+<tag-desc>
+writes a sent <literal>string</literal> to the error log
+on the <literal>error</literal> level of logging (0.2.0)
+</tag-desc>
+
+</list>
+</para>
+
+</section>
+
+</section>
+
+
+</article>
--- a/xml/en/docs/njs_about.xml
+++ b/xml/en/docs/njs_about.xml
@@ -9,7 +9,7 @@
 <article name="About njs"
         link="/en/docs/njs_about.html"
         lang="en"
-        rev="19">
+        rev="20">
 
 <section id="summary">
 
@@ -252,6 +252,15 @@ The complete list of njs changes is avai
 </section>
 
 
+<section id="njs_api" name="njs API Reference">
+
+<para>
+njs API reference is available
+<link doc="njs/njs_api.xml">here</link>.
+</para>
+</section>
+
+
 <section id="install" name="Download and install">
 
 <para>
--- a/xml/en/docs/stream/ngx_stream_js_module.xml
+++ b/xml/en/docs/stream/ngx_stream_js_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_stream_js_module"
         link="/en/docs/stream/ngx_stream_js_module.html"
         lang="en"
-        rev="10">
+        rev="11">
 
 <section id="summary">
 
@@ -230,79 +230,10 @@ Sets an njs function for the specified v
 
 
 <section id="properties" name="Session Object Properties">
-<para>
-Each stream njs handler receives one argument, a stream session object.
-</para>
 
 <para>
-The session object has the following properties:
-
-<list type="tag">
-
-<tag-name><literal>remoteAddress</literal></tag-name>
-<tag-desc>
-client address, read-only
-</tag-desc>
-
-<tag-name><literal>eof</literal></tag-name>
-<tag-desc>
-a boolean read-only property, true if the current buffer is the last buffer
-</tag-desc>
-
-<tag-name><literal>fromUpstream</literal></tag-name>
-<tag-desc>
-a boolean read-only property,
-true if the current buffer is from the upstream server to the client
-</tag-desc>
-
-<tag-name><literal>buffer</literal></tag-name>
-<tag-desc>
-the current buffer, writable
-</tag-desc>
-
-<tag-name><literal>variables{}</literal></tag-name>
-<tag-desc>
-nginx variables object, read-only
-</tag-desc>
-
-<tag-name><literal>OK</literal></tag-name>
-<tag-desc>
-the <literal>OK</literal> return code
-</tag-desc>
-
-<tag-name><literal>DECLINED</literal></tag-name>
-<tag-desc>
-the <literal>DECLINED</literal> return code
-</tag-desc>
-
-<tag-name><literal>AGAIN</literal></tag-name>
-<tag-desc>
-the <literal>AGAIN</literal> return code
-</tag-desc>
-
-<tag-name><literal>ERROR</literal></tag-name>
-<tag-desc>
-the <literal>ERROR</literal> return code
-</tag-desc>
-
-<tag-name><literal>ABORT</literal></tag-name>
-<tag-desc>
-the <literal>ABORT</literal> return code
-</tag-desc>
-</list>
-</para>
-
-<para>
-The session object has the following methods:
-
-<list type="tag">
-
-<tag-name><literal>log(<value>string</value>)</literal></tag-name>
-<tag-desc>
-writes a sent <value>string</value> to the error log
-on the <literal>info</literal> level of logging
-</tag-desc>
-</list>
+Each stream njs handler receives one argument, a stream session
+<link doc="../njs/njs_api.xml" id="stream_session">object</link>.
 </para>
 
 </section>
--- a/xml/ru/GNUmakefile
+++ b/xml/ru/GNUmakefile
@@ -107,6 +107,7 @@ REFS =									\
 		stream/ngx_stream_upstream_hc_module			\
 		stream/stream_processing				\
 		ngx_google_perftools_module				\
+		njs/njs_api						\
 
 TOP =									\
 		download						\
--- a/xml/ru/docs/http/ngx_http_js_module.xml
+++ b/xml/ru/docs/http/ngx_http_js_module.xml
@@ -9,7 +9,7 @@
 <module name="Модуль ngx_http_js_module"
         link="/ru/docs/http/ngx_http_js_module.html"
         lang="ru"
-        rev="10">
+        rev="11">
 
 <section id="summary">
 
@@ -161,183 +161,11 @@ function baz(req, res) {
 
 
 <section id="arguments" name="Аргументы запроса и ответа">
-<para>
-Каждый HTTP-обработчик njs получает два аргумента: запрос и ответ.
-</para>
-
-<para>
-Объект запроса имеет следующие свойства:
-<list type="tag">
-
-<tag-name><literal>uri</literal></tag-name>
-<tag-desc>
-текущий URI запроса, только чтение
-</tag-desc>
-
-<tag-name><literal>method</literal></tag-name>
-<tag-desc>
-метод запроса, только чтение
-</tag-desc>
-
-<tag-name><literal>httpVersion</literal></tag-name>
-<tag-desc>
-версия HTTP, только чтение
-</tag-desc>
-
-<tag-name><literal>remoteAddress</literal></tag-name>
-<tag-desc>
-адрес клиента, только чтение
-</tag-desc>
-
-<tag-name><literal>headers{}</literal></tag-name>
-<tag-desc>
-объект заголовков запроса, только чтение.
-<para>
-Например, доступ к заголовку <literal>Header-Name</literal>
-можно получить при помощи синтаксиса <literal>headers['Header-Name']</literal>
-или <literal>headers.Header_name</literal>
-</para>
-</tag-desc>
-
-<tag-name><literal>args{}</literal></tag-name>
-<tag-desc>
-объект аргументов запроса, только чтение
-</tag-desc>
-
-<tag-name><literal>variables{}</literal></tag-name>
-<tag-desc>
-объект переменных nginx, только чтение
-</tag-desc>
-
-<tag-name><literal>response</literal></tag-name>
-<tag-desc>
-объект ответа (0.2.0), только чтение
-</tag-desc>
-</list>
-</para>
-
-<para>
-Объект запроса имеет следующие свойства:
-<list type="tag">
-
-<tag-name><literal>log(<value>строка</value>)</literal></tag-name>
-<tag-desc>
-записывает <literal>строку</literal> в лог-файл ошибок
-на уровне лога <literal>info</literal>
-</tag-desc>
-
-<tag-name><literal>warn(<value>строка</value>)</literal></tag-name>
-<tag-desc>
-записывает <literal>строку</literal> в лог-файл ошибок
-на уровне лога <literal>warning</literal> (0.2.0)
-</tag-desc>
-
-<tag-name><literal>error(<value>строка</value>)</literal></tag-name>
-<tag-desc>
-записывает <literal>строку</literal> в лог-файл ошибок
-на уровне лога <literal>error</literal> (0.2.0)
-</tag-desc>
-
-<tag-name><literal>subrequest(<value>uri</value>[, <value>options</value>[,
-<value>callback</value>]])</literal></tag-name>
-<tag-desc>
-создаёт подзапрос с заданными <literal>uri</literal> и
-<literal>options</literal> и
-устанавливает необязательный <literal>callback</literal> завершения (0.2.0).
 
 <para>
-Если <literal>options</literal> является строкой, то в ней
-содержится срока аргументов подзапроса.
-В противном случае ожидается, что <literal>options</literal> является объектом
-со следующими ключами:
-<list type="tag">
-<tag-name><literal>args</literal></tag-name>
-<tag-desc>строка с аргументами</tag-desc>
-
-<tag-name><literal>body</literal></tag-name>
-<tag-desc>тело запроса</tag-desc>
-
-<tag-name><literal>method</literal></tag-name>
-<tag-desc>метод HTTP</tag-desc>
-</list>
-</para>
-
-<para>
-<literal>callback</literal> получает объект ответа
-со следующими свойствами:
-<literal>uri</literal>, <literal>method</literal>,
-<literal>status</literal>, <literal>contentType</literal>,
-<literal>contentLength</literal>, <literal>headers</literal>,
-<literal>args</literal>.
-Эти свойства имеют те же значения, что и свойства объекта запроса.
-Дополнительно у объекта ответа есть свойство <literal>body</literal>,
-содержащее тело ответа подзапроса,
-и свойство <literal>parent</literal>,
-ссылающееся на родительский объект запроса.
-</para>
-</tag-desc>
-</list>
-</para>
-
-<para>
-Объект ответа имеет следующие свойства:
-<list type="tag">
-
-<tag-name><literal>status</literal></tag-name>
-<tag-desc>
-статус ответа, доступно для записи
-</tag-desc>
-
-<tag-name><literal>headers{}</literal></tag-name>
-<tag-desc>
-объект заголовков ответа
-</tag-desc>
-
-<tag-name><literal>contentType</literal></tag-name>
-<tag-desc>
-значение поля <header>Content-Type</header> заголовка ответа,
-доступно для записи
-</tag-desc>
-
-<tag-name><literal>contentLength</literal></tag-name>
-<tag-desc>
-значение поля <header>Content-Length</header> заголовка ответа,
-доступно для записи
-</tag-desc>
-</list>
-</para>
-
-<para>
-Объект ответа имеет следующие методы:
-<list type="tag">
-
-<tag-name><literal>sendHeader()</literal></tag-name>
-<tag-desc>
-отправляет заголовок HTTP клиенту
-</tag-desc>
-
-<tag-name><literal>send(<value>строка</value>)</literal></tag-name>
-<tag-desc>
-отправляет часть тела ответа клиенту
-</tag-desc>
-
-<tag-name><literal>finish()</literal></tag-name>
-<tag-desc>
-завершает отправку ответа клиенту
-</tag-desc>
-
-<tag-name><literal>return(код[, строка])</literal></tag-name>
-<tag-desc>
-отправляет
-клиенту полный ответ с указанным <literal>кодом</literal> (0.2.0)
-<para>
-Можно задать или URL перенаправления
-(для кодов 301, 302, 303, 307 и 308),
-или текст тела ответа (для остальных кодов) в качестве второго аргумента.
-</para>
-</tag-desc>
-
-</list>
+Каждый HTTP-обработчик njs получает два аргумента,
+<link doc="../njs/njs_api.xml" id="http_request">запрос</link>
+и <link doc="../njs/njs_api.xml" id="http_response">ответ</link>.
 </para>
 
 </section>
new file mode 100644
--- /dev/null
+++ b/xml/ru/docs/njs/njs_api.xml
@@ -0,0 +1,361 @@
+<?xml version="1.0"?>
+
+<!--
+  Copyright (C) Nginx, Inc.
+  -->
+
+<!DOCTYPE article SYSTEM "../../../../dtd/article.dtd">
+
+<article name="njs API"
+        link="/ru/docs/njs/njs_api.html"
+        lang="ru"
+        rev="1">
+
+<section id="summary">
+
+<para>
+<link doc="../njs_about.xml">njs</link> предоставляет объекты, методы и свойства 
+для расширения функциональности nginx.
+</para>
+
+</section>
+
+
+<section id="http" name="HTTP">
+
+<para>
+Объекты <literal>HTTP</literal> доступны только в
+модуле <link doc="../http/ngx_http_js_module.xml">ngx_http_js_module</link>.
+</para>
+
+
+<section id="http_request" name="Запрос">
+
+<para>
+<list type="tag">
+
+<tag-name><literal>req.uri</literal></tag-name>
+<tag-desc>
+текущий URI запроса, только чтение
+</tag-desc>
+
+<tag-name><literal>req.method</literal></tag-name>
+<tag-desc>
+метод запроса, только чтение
+</tag-desc>
+
+<tag-name><literal>req.httpVersion</literal></tag-name>
+<tag-desc>
+версия HTTP, только чтение
+</tag-desc>
+
+<tag-name><literal>req.remoteAddress</literal></tag-name>
+<tag-desc>
+адрес клиента, только чтение
+</tag-desc>
+
+<tag-name><literal>req.headers{}</literal></tag-name>
+<tag-desc>
+объект заголовков запроса, только чтение.
+<para>
+Например, доступ к заголовку <literal>Header-Name</literal>
+можно получить при помощи синтаксиса <literal>headers['Header-Name']</literal>
+или <literal>headers.Header_name</literal>
+</para>
+</tag-desc>
+
+<tag-name><literal>req.args{}</literal></tag-name>
+<tag-desc>
+объект аргументов запроса, только чтение
+</tag-desc>
+
+<tag-name><literal>req.variables{}</literal></tag-name>
+<tag-desc>
+объект переменных nginx, только чтение
+</tag-desc>
+
+<tag-name><literal>req.response</literal></tag-name>
+<tag-desc>
+объект <link id="http_response_object">ответа</link> (0.2.0), только чтение
+</tag-desc>
+
+<tag-name><literal>req.log(<value>строка</value>)</literal></tag-name>
+<tag-desc>
+записывает <literal>строку</literal> в лог-файл ошибок
+на уровне лога <literal>info</literal>
+</tag-desc>
+
+<tag-name><literal>req.warn(<value>строка</value>)</literal></tag-name>
+<tag-desc>
+записывает <literal>строку</literal> в лог-файл ошибок
+на уровне лога <literal>warning</literal> (0.2.0)
+</tag-desc>
+
+<tag-name><literal>req.error(<value>строка</value>)</literal></tag-name>
+<tag-desc>
+записывает <literal>строку</literal> в лог-файл ошибок
+на уровне лога <literal>error</literal> (0.2.0)
+</tag-desc>
+
+<tag-name id="subrequest"><literal>req.subrequest(<value>uri</value>[,
+<value>options</value>[, <value>callback</value>]])</literal></tag-name>
+<tag-desc>
+создаёт подзапрос с заданными <literal>uri</literal> и
+<literal>options</literal> и
+устанавливает необязательный <literal>callback</literal> завершения (0.2.0).
+
+<para>
+Если <literal>options</literal> является строкой, то в ней
+содержится срока аргументов подзапроса.
+В противном случае ожидается, что <literal>options</literal> является объектом
+со следующими ключами:
+<list type="tag">
+<tag-name><literal>args</literal></tag-name>
+<tag-desc>
+строка с аргументами
+</tag-desc>
+
+<tag-name><literal>body</literal></tag-name>
+<tag-desc>
+тело запроса
+</tag-desc>
+
+<tag-name><literal>method</literal></tag-name>
+<tag-desc
+>метод HTTP
+</tag-desc>
+
+</list>
+</para>
+
+<para>
+<literal>callback</literal>
+получает объект <link id="http_reply">reply</link>.
+</para>
+</tag-desc>
+
+</list>
+</para>
+
+</section>
+
+
+<section id="http_response" name="Ответ">
+
+<para>
+<list type="tag">
+
+<tag-name><literal>res.status</literal></tag-name>
+<tag-desc>
+статус ответа, доступно для записи
+</tag-desc>
+
+<tag-name><literal>res.headers{}</literal></tag-name>
+<tag-desc>
+объект заголовков ответа
+</tag-desc>
+
+<tag-name><literal>res.contentType</literal></tag-name>
+<tag-desc>
+значение поля <header>Content-Type</header> заголовка ответа,
+доступно для записи
+</tag-desc>
+
+<tag-name><literal>res.contentLength</literal></tag-name>
+<tag-desc>
+значение поля <header>Content-Length</header> заголовка ответа,
+доступно для записи
+</tag-desc>
+
+<tag-name><literal>res.sendHeader()</literal></tag-name>
+<tag-desc>
+отправляет заголовок HTTP клиенту
+</tag-desc>
+
+<tag-name><literal>res.send(<value>строка</value>)</literal></tag-name>
+<tag-desc>
+отправляет часть тела ответа клиенту
+</tag-desc>
+
+<tag-name><literal>res.finish()</literal></tag-name>
+<tag-desc>
+завершает отправку ответа клиенту
+</tag-desc>
+
+<tag-name><literal>res.return(код[, строка])</literal></tag-name>
+<tag-desc>
+отправляет
+клиенту полный ответ с указанным <literal>кодом</literal> (0.2.0)
+<para>
+Можно задать или URL перенаправления
+(для кодов 301, 302, 303, 307 и 308),
+или текст тела ответа (для остальных кодов) в качестве второго аргумента
+</para>
+</tag-desc>
+
+</list>
+</para>
+
+</section>
+
+
+<section id="http_reply" name="Reply">
+
+<para>
+<list type="tag">
+
+<tag-name><literal>reply.uri</literal></tag-name>
+<tag-desc>
+текущий URI, только чтение
+</tag-desc>
+
+<tag-name><literal>reply.method</literal></tag-name>
+<tag-desc>
+метод, только чтение
+</tag-desc>
+
+<tag-name><literal>reply.status</literal></tag-name>
+<tag-desc>
+статус, доступно для записи
+</tag-desc>
+
+<tag-name><literal>reply.contentType</literal></tag-name>
+<tag-desc>
+значение поля <header>Content-Type</header> заголовка,
+доступно для записи
+</tag-desc>
+
+<tag-name><literal>reply.contentLength</literal></tag-name>
+<tag-desc>
+значение поля <header>Content-Length</header> заголовка,
+доступно для записи
+</tag-desc>
+
+<tag-name><literal>reply.headers{}</literal></tag-name>
+<tag-desc>
+объект заголовков ответа, только чтение
+</tag-desc>
+
+</list>
+</para>
+
+<para>
+Кроме того, у объект <literal>reply</literal> имеет
+следующие свойства:
+
+<list type="tag">
+
+<tag-name><literal>reply.body</literal></tag-name>
+<tag-desc>
+хранит тело ответа подзапроса
+</tag-desc>
+
+<tag-name><literal>reply.parent</literal></tag-name>
+<tag-desc>
+ссылается на родительский объект запроса
+</tag-desc>
+
+</list>
+</para>
+
+</section>
+
+</section>
+
+
+<section id="stream" name="Stream">
+
+<para>
+Объекты <literal>stream</literal> доступны только в
+модуле
+<link doc="../stream/ngx_stream_js_module.xml">ngx_stream_js_module</link>.
+</para>
+
+
+<section id="stream_session" name="Сессия">
+
+<para>
+<list type="tag">
+
+<tag-name><literal>s.remoteAddress</literal></tag-name>
+<tag-desc>
+адрес клиента, только чтение
+</tag-desc>
+
+<tag-name><literal>s.eof</literal></tag-name>
+<tag-desc>
+логическое свойство,
+true, если текущий буфер является последним буфером,
+только чтение
+</tag-desc>
+
+<tag-name><literal>s.fromUpstream</literal></tag-name>
+<tag-desc>
+логическое свойство,
+true, если текущий буфер является буфером от проксируемого сервера к клиенту,
+только чтение
+</tag-desc>
+
+<tag-name><literal>s.buffer</literal></tag-name>
+<tag-desc>
+текущий буфер, доступен для записи
+</tag-desc>
+
+<tag-name><literal>s.variables{}</literal></tag-name>
+<tag-desc>
+объект переменных nginx, только чтение
+</tag-desc>
+
+<tag-name><literal>s.OK</literal></tag-name>
+<tag-desc>
+код <literal>OK</literal>
+</tag-desc>
+
+<tag-name><literal>s.DECLINED</literal></tag-name>
+<tag-desc>
+код <literal>DECLINED</literal>
+</tag-desc>
+
+<tag-name><literal>s.AGAIN</literal></tag-name>
+<tag-desc>
+код <literal>AGAIN</literal>
+</tag-desc>
+
+<tag-name><literal>s.ERROR</literal></tag-name>
+<tag-desc>
+код <literal>ERROR</literal>
+</tag-desc>
+
+<tag-name><literal>s.ABORT</literal></tag-name>
+<tag-desc>
+код <literal>ABORT</literal>
+</tag-desc>
+
+<tag-name><literal>s.log(<value>строка</value>)</literal></tag-name>
+<tag-desc>
+записывает отправленную <value>строку</value> в лог-файл ошибок
+на уровне лога <literal>info</literal>
+</tag-desc>
+
+<tag-name><literal>s.warn(<value>строка</value>)</literal></tag-name>
+<tag-desc>
+записывает отправленную <literal>строку</literal> в лог-файл ошибок
+на уровне лога <literal>warning</literal> (0.2.0)
+</tag-desc>
+
+<tag-name><literal>s.error(<value>строка</value>)</literal></tag-name>
+<tag-desc>
+записывает отправленную <literal>строку</literal> в лог-файл ошибок
+на уровне лога <literal>error</literal> (0.2.0)
+</tag-desc>
+
+</list>
+</para>
+
+</section>
+
+</section>
+
+
+</article>
+
--- a/xml/ru/docs/njs_about.xml
+++ b/xml/ru/docs/njs_about.xml
@@ -9,7 +9,7 @@
 <article name="Информация о njs"
         link="/ru/docs/njs_about.html"
         lang="ru"
-        rev="19">
+        rev="20">
 
 <section id="summary">
 
@@ -250,6 +250,14 @@ labels
 </para>
 </section>
 
+<section id="njs_api" name="Справочник njs API">
+
+<para>
+Справочник njs API доступен
+<link doc="njs/njs_api.xml">здесь</link>.
+</para>
+</section>
+
 
 <section id="install" name="Загрузка и установка">
 
--- a/xml/ru/docs/stream/ngx_stream_js_module.xml
+++ b/xml/ru/docs/stream/ngx_stream_js_module.xml
@@ -9,7 +9,7 @@
 <module name="Модуль ngx_stream_js_module"
         link="/ru/docs/stream/ngx_stream_js_module.html"
         lang="ru"
-        rev="10">
+        rev="11">
 
 <section id="summary">
 
@@ -231,83 +231,10 @@ function xyz(s) {
 
 
 <section id="properties" name="Свойства объекта сессии">
-<para>
-Каждый stream-обработчик njs получает один аргумент:
-объект stream-сессии.
-</para>
 
 <para>
-Объект сессии имеет следующие свойства:
-
-<list type="tag">
-
-<tag-name><literal>remoteAddress</literal></tag-name>
-<tag-desc>
-адрес клиента, только чтение
-</tag-desc>
-
-<tag-name><literal>eof</literal></tag-name>
-<tag-desc>
-логическое свойство,
-true, если текущий буфер является последним буфером,
-только чтение
-</tag-desc>
-
-<tag-name><literal>fromUpstream</literal></tag-name>
-<tag-desc>
-логическое свойство,
-true, если текущий буфер является буфером от проксируемого сервера к клиенту,
-только чтение
-</tag-desc>
-
-<tag-name><literal>buffer</literal></tag-name>
-<tag-desc>
-текущий буфер, доступен для записи
-</tag-desc>
-
-<tag-name><literal>variables{}</literal></tag-name>
-<tag-desc>
-объект переменных nginx, только чтение
-</tag-desc>
-
-<tag-name><literal>OK</literal></tag-name>
-<tag-desc>
-код <literal>OK</literal>
-</tag-desc>
-
-<tag-name><literal>DECLINED</literal></tag-name>
-<tag-desc>
-код <literal>DECLINED</literal>
-</tag-desc>
-
-<tag-name><literal>AGAIN</literal></tag-name>
-<tag-desc>
-код <literal>AGAIN</literal>
-</tag-desc>
-
-<tag-name><literal>ERROR</literal></tag-name>
-<tag-desc>
-код <literal>ERROR</literal>
-</tag-desc>
-
-<tag-name><literal>ABORT</literal></tag-name>
-<tag-desc>
-код <literal>ABORT</literal>
-</tag-desc>
-</list>
-</para>
-
-<para>
-Объект сессии имеет следующие методы:
-
-<list type="tag">
-
-<tag-name><literal>log(<value>строка</value>)</literal></tag-name>
-<tag-desc>
-записывает отправленную <value>строку</value> в лог-файл ошибок
-на уровне лога <literal>info</literal>
-</tag-desc>
-</list>
+Каждый stream-обработчик njs получает один аргумент,
+<link doc="../njs/njs_api.xml" id="stream_session">объект</link> stream-сессии.
 </para>
 
 </section>