{"id":15091409,"url":"https://github.com/dapperdox/dapperdox","last_synced_at":"2025-04-05T08:09:09.702Z","repository":{"id":44430898,"uuid":"53501749","full_name":"DapperDox/dapperdox","owner":"DapperDox","description":"Beautiful, integrated, OpenAPI documentation.","archived":false,"fork":false,"pushed_at":"2023-11-07T08:04:21.000Z","size":12729,"stargazers_count":415,"open_issues_count":51,"forks_count":58,"subscribers_count":20,"default_branch":"master","last_synced_at":"2025-04-05T08:09:03.713Z","etag":null,"topics":["golang","openapi","openapi-documentation","openapi-specification"],"latest_commit_sha":null,"homepage":"http://dapperdox.io","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DapperDox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-03-09T13:57:50.000Z","updated_at":"2025-03-15T14:12:45.000Z","dependencies_parsed_at":"2024-01-08T08:03:06.331Z","dependency_job_id":"9d1eff46-8f8a-465d-9cd3-df656b5484b6","html_url":"https://github.com/DapperDox/dapperdox","commit_stats":null,"previous_names":["zxchris/swaggerly"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DapperDox%2Fdapperdox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DapperDox%2Fdapperdox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DapperDox%2Fdapperdox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DapperDox%2Fdapperdox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DapperDox","download_url":"https://codeload.github.com/DapperDox/dapperdox/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247305935,"owners_count":20917208,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["golang","openapi","openapi-documentation","openapi-specification"],"created_at":"2024-09-25T10:40:59.085Z","updated_at":"2025-04-05T08:09:09.680Z","avatar_url":"https://github.com/DapperDox.png","language":"Go","readme":"# DapperDox\u0026nbsp;\u0026nbsp;\u0026nbsp;[![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)\n\n### Beautiful, integrated, OpenAPI documentation.\n\n\u003e 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.\n\n![DapperDox logo](/docs/logo-dapperdox-github.png \"DapperDox\")\n\n## Features\n\n* Author full documentation in GitHub Flavoured Markdown.\n* Document multiple API specifications as a suite of cross-referenced products.\n* Seamlessly overlay content onto the automatically generated reference documentation.\n* Integrate the built-in API explorer with your APIs and authentication model.\n* Proxy your developer platform, allowing full integration of API key management.\n* Choose from multiple themes, or create your own.\n\n## Documentation and usage\n\nDetailed usage instructions are available on the [DapperDox website http://dapperdox.io](http://dapperdox.io).\n\n## Quickstart\n\nWe provide the lastest release builds for the most common operating systems and architectures, which you\ncan download from [releases](https://github.com/DapperDox/dapperdox/releases),\nor you can build from source by cloning this repo..\nSee [downloads](http://dapperdox.io/download/downloads) for further information.\n\n### Build from source\n\nFirst build DapperDox (this assumes that you have your golang environment configured correctly):\n```bash\ngo get \u0026\u0026 go build\n```\n\n### Running DapperDox\n\nStart up DapperDox, pointing it to your OpenAPI 2.0 specification file:\n\n```\n./dapperdox -spec-dir=\u003clocation of OpenAPI 2.0 spec\u003e\n```\n\nDapperDox 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\npassing parameter `-spec-dir=examples/specifications/petstore` will build the petstore documentation.\n\nDapperDox will default to serving documentation from port 3123 on all interfaces, so you can point your \nweb browser at http://127.0.0.1:3123 or http://localhost:3123.\n\nFor an out-of-the-box example, execute the example run script:\n\n```bash\n./run_example.sh\n```\n\nThis demonstrates many of the configuration options available. See [configuration](http://dapperdox.io/docs/configuration-guide).\n\n## Acknowledgements\n\nMany thanks to [Ian Kent](https://github.com/ian-kent) who spiked the Golang implementation of DapperDox\nas part of a bigger project. His commit history was lost when DapperDox was extracted into a stand-alone\nproject, but its core retains his valuable work.\n\n[David Mort](https://github.com/davidmort) for painstaking testing, and bug fixing.\n\n\n\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdapperdox%2Fdapperdox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdapperdox%2Fdapperdox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdapperdox%2Fdapperdox/lists"}