This exposes a service to automatically generate specs from various source formats.
Start the server listening on port 80 by default:
You can specify a port like so:
PORT=3000 node server
When developing, you can use auto-reload:
Spec Generator has a single endpoint, which is a
GET /. This endpoint accepts parameters on its
query string. If the call is successful the generated content of the specification is returned.
type(required). The type of generator for this content. Currently the only supported value is
url(required). The URL of the draft to fetch and generate from.
publishDate. The date at which the publication of this draft is supposed to occur.
As a Node.js module
const SPEC_GEN = require('w3c-spec-generator'); const SERVER = SPEC_GEN.start(); // Optional port number (80 by default) // Now Spec Generator is listening on port 80 SERVER.close(); // To stop the server
If a required parameter is missing or has a value that is not understood, the generator returns a
500 error with a JSON payload the
error field of which is the human-readable error message.
If the specific generator encounters a problem a similar error (mostly likely
500) with the same
sort of JSON message is returned. Specific generator types can extend this behaviour. The
generator only returns
Generators are simple to write and new ones can easily be added. Simply add a new one under
generators and load it into the
genMap near the top of
Generators must export a
generate() method which takes a URL, a set of parameters (from the list
of optional ones that the API supports), and a callback to invoke upon completion.
If there is an error, the callback's first argument must be an object with a
status field being
an HTTP error code and a
message field containing the error message. If the generator is
successful the first argument is
null and the second is the generated content.