Validator.nu Web Service Interface: Difference between revisions
m (Add category)
|Line 58:||Line 58:|
Revision as of 10:12, 18 August 2008
Validator.nu can be called as a Web service. Input and output modes can be chosen completely orthogonally. Responses and requests can be optionally compressed (independently of each other).
(Please use the Web service API reasonably. See the Terms of Service.)
For most Web service use cases, you should probably POST the document as the HTTP entity body.
- Document URL as a GET parameter; the service retrieves the document by URL over HTTP or HTTPS.
- Document POSTed as the HTTP entity body; parameters in query string as with GET.
- Document POSTed as a
- Document POSTed as a form-based file upload.
- Document in a
data:URI as a GET parameter.
When using Validator.nu as a Web service back end, the XML and JSON output formats are recommended for forward compatibility. The available JSON tooling probably makes consuming JSON easier. The XML format contains XHTML elaborations that are not available in JSON. Both formats are streaming, but streaming XML parsers are more readily available. XML cannot represent some input strings faithfully.
- HTML with microformat-style
classannotations (default output; should not be assumed to be forward-compatibly stable).
- XHTML with microformat-style
&out=xhtmlto URL; should not be assumed to be forward-compatibly stable).
- XML (append
- JSON (append
- GNU error format (append
- Human-readably plain text (append
&out=textto URL; should not be assumed to be forward-compatibly stable for machine parsing—use the GNU format for that).
- Relaxed-compatible (lacks a spec)
- Unicorn-compatible (hoping that Unicorn changes instead)
- W3C Validator-compatible SOAP (legacy)
- EARL (not implemented; domain modeling mismatch)
Validator.nu supports compression in order to save bandwidth.
Validator.nu supports HTTP request compression. To use it, compress the request entity body using gzip and specify
Content-Encoding: gzip as a request header.
Validator.nu supports HTTP response compression. Please use it. Response compression is orthogonal to the input methods and output formats.
The standard HTTP gzip mechanism is used. To indicated that you prepared to handle gzipped responses, include the
Accept-Encoding: gzip request header. When the header is present, Validator.nu will gzip compress the response. You should also be prepared to receive an uncompressed, though, since in the future it may make sense to turn off compression under heavy CPU load.
There a sample Python program that shows how to deal with compression and redirects. (It may not be exemplary Python, though.)