https://github.com/dapperdox/dapperdox

Beautiful, integrated, OpenAPI documentation.
https://github.com/dapperdox/dapperdox

golang openapi openapi-documentation openapi-specification

Last synced: 4 days ago
JSON representation

Beautiful, integrated, OpenAPI documentation.

• Host: GitHub
• URL: https://github.com/dapperdox/dapperdox
• Owner: DapperDox
• License: gpl-3.0
• Created: 2016-03-09T13:57:50.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-11-07T08:04:21.000Z (about 1 year ago)
• Last Synced: 2024-12-21T23:09:51.484Z (4 days ago)
• Topics: golang, openapi, openapi-documentation, openapi-specification
• Language: Go
• Homepage: http://dapperdox.io
• Size: 12.1 MB
• Stars: 410
• Watchers: 22
• Forks: 59
• Open Issues: 51
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DapperDox   [![Build Status](https://travis-ci.org/DapperDox/dapperdox.svg?branch=master)](https://travis-ci.org/DapperDox/dapperdox) [![Download](https://img.shields.io/badge/release-v1.1.1-green.svg) ](https://github.com/DapperDox/dapperdox/releases/tag/v1.1.1)

### 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](https://developer.companieshouse.gov.uk/api/docs/) built with the alpha version.

![DapperDox logo](/docs/logo-dapperdox-github.png "DapperDox")

## 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](http://dapperdox.io).

## Quickstart

We provide the lastest release builds for the most common operating systems and architectures, which you

can download from [releases](https://github.com/DapperDox/dapperdox/releases),

or you can build from source by cloning this repo..

See [downloads](http://dapperdox.io/download/downloads) for further information.

### Build from source

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

```bash

go get && go build

```

### Running DapperDox

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

```

./dapperdox -spec-dir=

```

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:

```bash

./run_example.sh

```

This demonstrates many of the configuration options available. See [configuration](http://dapperdox.io/docs/configuration-guide).

## Acknowledgements

Many thanks to [Ian Kent](https://github.com/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](https://github.com/davidmort) for painstaking testing, and bug fixing.