diff --git a/basis/http/client/client-docs.factor b/basis/http/client/client-docs.factor index 7031f5d16c..9a8aa48738 100644 --- a/basis/http/client/client-docs.factor +++ b/basis/http/client/client-docs.factor @@ -1,6 +1,6 @@ USING: http help.markup help.syntax io.pathnames io.streams.string io.encodings.8-bit io.encodings.binary kernel strings urls -urls.encoding byte-arrays strings assocs sequences ; +urls.encoding byte-arrays strings assocs sequences destructors ; IN: http.client HELP: download-failed @@ -36,7 +36,12 @@ HELP: http-get HELP: http-post { $values { "post-data" object } { "url" "a " { $link url } " or " { $link string } } { "response" response } { "data" sequence } } -{ $description "Submits a form at a URL." } +{ $description "Submits an HTTP POST request." } +{ $errors "Throws an error if the HTTP request fails." } ; + +HELP: http-put +{ $values { "post-data" object } { "url" "a " { $link url } " or " { $link string } } { "response" response } { "data" sequence } } +{ $description "Submits an HTTP PUT request." } { $errors "Throws an error if the HTTP request fails." } ; HELP: with-http-get @@ -67,17 +72,36 @@ ARTICLE: "http.client.get" "GET requests with the HTTP client" { $subsection with-http-get } { $subsection with-http-request } ; -ARTICLE: "http.client.post" "POST requests with the HTTP client" -"As with GET requests, there is a high-level word which takes a " { $link url } " and a lower-level word which constructs an HTTP request object which can be passed to " { $link http-request } ":" -{ $subsection http-post } -{ $subsection } -"Both words take a post data parameter, which can be one of the following:" +ARTICLE: "http.client.post-data" "HTTP client submission data" +"HTTP POST and PUT request words take a post data parameter, which can be one of the following:" { $list - { "a " { $link byte-array } " or " { $link string } " is sent the server without further encoding" } - { "an " { $link assoc } " is interpreted as a series of form parameters, which are encoded with " { $link assoc>query } } + { "a " { $link byte-array } ": the data is sent the server without further encoding" } + { "a " { $link string } ": the data is encoded and then sent as a series of bytes" } + { "an " { $link assoc } ": the assoc is interpreted as a series of form parameters, which are encoded with " { $link assoc>query } } + { "an input stream: the contents of the input stream are transmitted to the server without being read entirely into memory - this is useful for large requests" } { { $link f } " denotes that there is no post data" } + { "a " { $link post-data } " tuple, for additional control" } +} +"When passing a stream, you must ensure the stream is closed afterwards. The best way is to use " { $link with-disposal } " or " { $link "destructors" } ". For example," +{ $code + "\"my-large-post-request.txt\" ascii " + "[ URL\" http://www.my-company.com/web-service\" http-post ] with-disposal" } ; +ARTICLE: "http.client.post" "POST requests with the HTTP client" +"Basic usage involves passing post data and a " { $link url } ", and getting a " { $link response } " and data back:" +{ $subsection http-post } +"Advanced usage involves constructing a " { $link request } ", which allows " { $link "http.cookies" } " and " { $link "http.headers" } " to be set:" +{ $subsection } +"Both words take a post data parameter; see " { $link "http.client.post-data" } "." ; + +ARTICLE: "http.client.put" "PUT requests with the HTTP client" +"Basic usage involves passing post data and a " { $link url } ", and getting a " { $link response } " and data back:" +{ $subsection http-post } +"Advanced usage involves constructing a " { $link request } ", which allows " { $link "http.cookies" } " and " { $link "http.headers" } " to be set:" +{ $subsection } +"Both words take a post data parameter; see " { $link "http.client.post-data" } "." ; + ARTICLE: "http.client.encoding" "Character encodings and the HTTP client" "The " { $link http-request } ", " { $link http-get } " and " { $link http-post } " words output a sequence containing data that was sent by the server." $nl @@ -95,11 +119,14 @@ ARTICLE: "http.client.errors" "HTTP client errors" ARTICLE: "http.client" "HTTP client" "The " { $vocab-link "http.client" } " vocabulary implements an HTTP and HTTPS client on top of " { $link "http" } "." $nl -"For HTTPS support, you must load the " { $vocab-link "urls.secure" } " vocab first. If you don't load it, HTTPS will not load and images generated by " { $vocab-link "tools.deploy" } " will be smaller as a result." +"For HTTPS support, you must load the " { $vocab-link "urls.secure" } " vocab first. If you don't need HTTPS support, don't load " { $vocab-link "urls.secure" } "; this will reduce the size of images generated by " { $vocab-link "tools.deploy" } "." $nl "There are two primary usage patterns, data retrieval with GET requests and form submission with POST requests:" { $subsection "http.client.get" } { $subsection "http.client.post" } +{ $subsection "http.client.put" } +"Submission data for POST and PUT requests:" +{ $subsection "http.client.post-data" } "More esoteric use-cases, for example HTTP methods other than the above, are accomodated by constructing an empty request object with " { $link } " and filling everything in by hand." { $subsection "http.client.encoding" } { $subsection "http.client.errors" }