OpenAPI / Swagger, AsyncAPI & Semoasa definitions to Slate / Shins compatible markdown
JavaScript Shell
Permalink
Failed to load latest commit information.
bin Add harmony flag for node 6, and update docs May 10, 2018
defs AsyncAPI v1.2.0 evented and streaming API support May 13, 2018
docs docs; update screenshot Feb 5, 2018
resources Initial work on SEMOASA support Oct 11, 2017
templates fix; string example values, refs #130 May 30, 2018
test tests; make language_clients usage agree with docs, refs #127 May 10, 2018
utils Allow loading options from file, refs #37 Sep 13, 2017
.editorconfig misc; .editorconfig setup for *.md files Jan 29, 2018
.eslintrc.json linter fixes Mar 3, 2018
.gitattributes openapi3; set id explicitly on schema h2 headers Dec 19, 2017
.gitignore use regex matching for contentTypes, refs #92 Mar 23, 2018
.travis.yml travis; update build targets May 1, 2018
LICENSE Initial commit Oct 5, 2016
README.md docs; Add link to api2html May 18, 2018
apiblueprint.js linter fixes Mar 3, 2018
asyncapi1.js Added a slugify function to data.utils of asyncapi1, openapi3 and sem… May 11, 2018
common.js Added a slugify function to data.utils of asyncapi1, openapi3 and sem… May 11, 2018
example_env.json add Golang template (#93) Mar 26, 2018
harGenerator.js Support non-string header example values for httpsnippet mode, refs #124 May 10, 2018
httpsnippetGenerator.js Error logging improvements for #124 May 10, 2018
index.js Move asyncapi -> asyncapi1 Mar 30, 2018
openapi2.js bug; rationalise usage of callback(err) Apr 3, 2018
openapi3.js fix; string example values, refs #130 May 30, 2018
package-lock.json 3.4.1 May 29, 2018
package.json 3.4.1 May 29, 2018
semoasa.js Added a slugify function to data.utils of asyncapi1, openapi3 and sem… May 11, 2018
statusCodes.json Add statusCode 103 - Early Hints Dec 22, 2017
testRunner.js fix; testRunner undefined checks May 30, 2018
whiteboard_env.json add Golang template (#93) Mar 26, 2018
widdershins.js Add --yaml option for JSON schemas in YAML format May 12, 2018

README.md

widdershins

OpenAPI / Swagger / AsyncAPI / Semoasa definition to Slate / Shins compatible markdown

Build Tested on APIs.guru Tested on Mermade OpenAPIs Known Vulnerabilities

Widdershins adverb:

  • In a direction contrary to the sun's course;
  • anticlockwise;
  • helping you produce static documentation from your OpenAPI 3.0 / Swagger 2.0 / AsyncAPI 1.x / Semoasa 0.1.0 definition

Widdershins screenshot

News

  • As of v3.0.0 Widdershins no longer expands the definition of OpenAPI body parameters / requestBodies by default, unless they have an inline schema. You can restore the old behaviour by using the --expandBody option.
  • You may limit the depth of schema examples using the --maxDepth option. The default is 10.
  • To omit schemas entirely, please copy and customise the main.dot template.
  • As of v3.1.0 Widdershins includes a generated Authorization header in OpenAPI code samples. If you wish to omit this, see here.
  • If you are using Node.js 6 or lower, please specify the --harmony flag.

To install

  • Clone the git repository, or
  • npm install [-g] widdershins, or
  • yarn global add widdershins
node widdershins [options] {input-file|url} [[-o] output markdown]
  --expandBody          Expand requestBody properties in parameters    [boolean]
  --headings            Levels of headings to expand in TOC[number] [default: 2]
  --omitBody            Omit top-level fake body parameter object      [boolean]
  --resolve             Resolve external $refs                         [boolean]
  --shallowSchemas      Don't expand schemas past $refs                [boolean]
  --summary             Use summary instead of operationId for TOC     [boolean]
  --verbose             Increase verbosity                             [boolean]
  -h, --help            Show help                                      [boolean]
  --version             Show version number                            [boolean]
  -c, --code            Turn generic code samples off                  [boolean]
  --httpsnippet         Use httpsnippet to generate code samples
                                                      [boolean] [default: false]
  -d, --discovery       Include schema.org WebAPI discovery data       [boolean]
  -e, --environment     Load config/override options from file          [string]
  -i, --includes        List of files to include, comma separated       [string]
  -l, --lang            Automatically generate list of languages for code
                        samples                                        [boolean]
  --language_tabs       List of language tabs for code samples using
                        "language[:label[:client]]" format              [string]
  -m, --maxDepth        Maximum depth for schema examples          [default: 10]
  -o, --outfile         File to write output markdown to                [string]
  -r, --raw             Output raw schemas not example values          [boolean]
  -s, --search          Whether to enable search or not, default true
                                                       [boolean] [default: true]
  -t, --theme           Syntax-highlighter theme to use                 [string]
  -u, --user_templates  directory to load override templates from       [string]
  -x, --experimental    For backwards compatibility only, ignored      [boolean]
  -y, --yaml            Display JSON schemas in YAML format            [boolean]

or

var converter = require('widdershins');
var options = {}; // defaults shown
options.codeSamples = true;
options.httpsnippet = false;
//options.language_tabs = [];
//options.language_clients = [];
//options.loadedFrom = sourceUrl;
//options.user_templates = './user_templates';
options.templateCallback = function(templateName,stage,data) { return data };
options.theme = 'darkula';
options.search = true;
options.sample = true; // set false by --raw
options.discovery = false;
options.includes = [];
options.shallowSchemas = false;
options.summary = false;
options.headings = 2;
options.yaml = false;
converter.convert(apiObj,options,function(err,str){
  // str contains the converted markdown
});

The headings option is currently only supported by Shins, not Slate which lacks this feature.

To only include a subset of the pre-defined language-tabs, or to rename their display-names, you can override the options.language_tabs:

options.language_tabs = [{ 'go': 'Go' }, { 'http': 'HTTP' }, { 'javascript': 'JavaScript' }, { 'javascript--nodejs': 'Node.JS' }, { 'python': 'Python' }, { 'ruby': 'Ruby' }];

The --environment option specifies a JSON or YAML-formatted options object, for example:

{ 
  "language_tabs": [{ "go": "Go" }, { "http": "HTTP" }, { "javascript": "JavaScript" }, { "javascript--nodejs": "Node.JS" }, { "python": "Python" }, { "ruby": "Ruby" }],
  "verbose": true
}

If you need to support a version of Slate <v1.5.0 (or a renderer which also doesn't support display-names for language-tabs, such as node-slate, slate-node or whiteboard), you can use the --environment option with the included whiteboard_env.json file to simply achieve this.

If you are using the httpsnippet option to generate code samples, you can specify the client library used to perform the requests for each language by overriding the options.language_clients:

options.language_clients = [{ 'shell': 'curl' }, { 'node': 'request' }, { 'java': 'unirest' }];

To see the list of languages and clients supported by httpsnippet, click here.

The loadedFrom option is only needed where the OpenAPI / Swagger definition does not specify a host, and (as per the OpenAPI specification) the API endpoint is deemed to be based on the source URL the definition was loaded from.

Note that the list of included files is simply passed into the header of the markdown file, they are actually included by Slate or the alternative you use.

To see the list of highlight-js syntax highlighting themes, click here.

Schema.org WebAPI discovery data is included if the discovery option above is set true. See the W3C WebAPI Discovery Community Group for more information.

Language tabs

Widdershins supports the x-code-samples vendor-extension to completely customise your documentation. Alternatively, you can edit the default code-samples in the templates sub-directory, or override them using the user_templates option to specify a directory containing your templates.

Widdershins supports the use of multiple language tabs with the same language (i.e. plain Javascript and Node.Js). To use this support you must be using Slate (or one of its ports compatible with) version 1.5.0 or higher. Shins versions track Slate version numbers.

Template parameters

Templates are compiled with doT.js.

Templates have access to a data object with a range of properties based on the document context.

If you specify an options.templateCallback function, it will be called before and after each template, with three parameters, the template name, the stage, ('pre' or 'post') and the current data object. You can mutate the data object in any way you see fit, as long as you return it. Content in the data.append property will be appended to the current output stream.

User templates

To override a .dot template, you need to copy over the child .def partials as well.

To override a .def partial, you need to copy over the parent .dot template as well. For OpenAPI 3 this will be main.dot except for parameters, responses and callbacks, which are children of the operation.dot template.

This means it is usually easiest to copy all .dot and .def files to your user templates directory. A visual diff tool which can run across two directories (such as Meld or WinMerge) may be useful in bringing in changes from Widdershins updates.

Tests

To run a test-suite:

node testRunner {path-to-APIs}

The test harness currently expects .yaml or .json files and has been tested against

Comparison between this and other OpenAPI / Swagger to Slate tools

Blog posting by the author of Widdershins.

Acknowledgements

Widdershins in the wild

Please feel free to add a link to your API documentation here.

Widdershins and Shins

If you need a wrapper around both Widdershins and Shins, why not consider the following projects: