Go JavaScript CSS Makefile Shell Batchfile
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets Handle the notion of an array resource at the response and body level… Mar 7, 2018
config Added licences Aug 4, 2017
docs Updated README Dec 6, 2016
examples Handle the notion of an array resource at the response and body level… Mar 7, 2018
handlers Replace '.' with '-' in navigation id as '.' breaks javascript. Feb 12, 2018
logger Added licences Aug 4, 2017
navigation Added licences Aug 4, 2017
network Added licences Aug 4, 2017
proxy Added licences Aug 4, 2017
render Fix correctly deadlock issue Sep 29, 2017
spec Handle the notion of an array resource at the response and body level… Mar 7, 2018
.gitignore Renamed all references to swaggerly to dapperdox. Nov 21, 2016
.travis.yml Add travis build. Dec 5, 2016
LICENSE Added licences Aug 4, 2017
Makefile Take release version from branch, improved release table generation. Mar 8, 2018
README.md Updates version number in README.md Apr 10, 2017
build.sh #64 added the shebang to shell scripts that were missing it, updated … Aug 5, 2017
buildzip Makes release build impact on repo a lot cleaner. Apr 13, 2017
createReleaseTable.sh Take release version from branch, improved release table generation. Mar 8, 2018
main.go Take release version from branch, improved release table generation. Mar 8, 2018
run_example.bat Added missing run_example.bat and set version to 1.2.0 Mar 7, 2018
run_example.sh Implementing better indication of array response in Response table. Mar 7, 2018
run_metadata.sh #64 added the shebang to shell scripts that were missing it, updated … Aug 5, 2017

README.md

DapperDox   Build Status Download

Beautiful, integrated, OpenAPI documentation.

Themed documentation generator, server and API explorer for OpenAPI (Swagger) Specifications. Helps you build integrated, browsable reference documentation and guides. For example, the Companies House Developer Hub built with the alpha version.

DapperDox logo

Features

  • Author full documentation in GitHub Flavoured Markdown.
  • Document multiple API specifications as a suite of cross-referenced products.
  • Seamlessly overlay content onto the automatically generated reference documentation.
  • Integrate the built-in API explorer with your APIs and authentication model.
  • Proxy your developer platform, allowing full integration of API key management.
  • Choose from multiple themes, or create your own.

Documentation and usage

Detailed usage instructions are available on the DapperDox website http://dapperdox.io.

Quickstart

We provide the lastest release builds for the most common operating systems and architectures, which you can download from releases, or you can build from source by cloning this repo.. See downloads for further information.

Build from source

First build DapperDox (this assumes that you have your golang environment configured correctly):

go get && go build

Running DapperDox

Start up DapperDox, pointing it to your OpenAPI 2.0 specification file:

./dapperdox -spec-dir=<location of OpenAPI 2.0 spec>

DapperDox looks for the file swagger.json at the -spec-dir location, and builds reference documentation for the OpenAPI specification it finds. For example, the obligatory petstore OpenAPI specification is provided in the examples/specifications/petstore directory, so passing parameter -spec-dir=examples/specifications/petstore will build the petstore documentation.

DapperDox will default to serving documentation from port 3123 on all interfaces, so you can point your web browser at http://127.0.0.1:3123 or http://localhost:3123.

For an out-of-the-box example, execute the example run script:

./run_example.sh

This demonstrates many of the configuration options available. See configuration.

Acknowledgements

Many thanks to Ian Kent who spiked the Golang implementation of DapperDox as part of a bigger project. His commit history was lost when DapperDox was extracted into a stand-alone project, but its core retains his valuable work.

David Mort for painstaking testing, and bug fixing.