This is a Docker image that will take an OpenAPI (v3) YAML document and produce a static Slate site suitable for publication on GitHub Pages or wherever. The widdershins library is responsible for converting the YAML/JSON into something Slate can use.
$ docker build -t api-doc-pipeline .Assuming the API YAML specification file is /projects/api/api.yaml:
$ docker run -v /projects/api:/work/source --rm api-doc-pipelineThe resulting HTML, JS, CSS, &c. will be available in /projects/api alongside the original source.
The filename api.yaml is hardcoded.
Widdershins options should be set in (with the path assumptions above)
the file /projects/api/widdershins.yaml.
This file will look something like
resolve: true
tocSummary: true
omitBody: true
language_tabs:
- http: HTTP
- python: Python
- csharp: 'C#'
- powershell: PowerShell
MIT License
Copyright (c) 2019 Bunny Lushington
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.