{"id":15757935,"url":"https://github.com/ahmadnassri/docker-rapidoc-server","last_synced_at":"2025-04-30T21:10:30.615Z","repository":{"id":38305139,"uuid":"309566851","full_name":"ahmadnassri/docker-rapidoc-server","owner":"ahmadnassri","description":"RapiDoc server with live reload","archived":false,"fork":false,"pushed_at":"2025-02-19T22:08:02.000Z","size":120,"stargazers_count":1,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-30T20:03:04.380Z","etag":null,"topics":["docker","rapidoc","server"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ahmadnassri.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["ahmadnassri"]}},"created_at":"2020-11-03T03:54:23.000Z","updated_at":"2025-02-19T22:08:06.000Z","dependencies_parsed_at":"2025-01-10T05:30:21.375Z","dependency_job_id":null,"html_url":"https://github.com/ahmadnassri/docker-rapidoc-server","commit_stats":{"total_commits":218,"total_committers":4,"mean_commits":54.5,"dds":"0.22477064220183485","last_synced_commit":"081a06199d3a5e0738202d8dbf53dd9c7e9eb8d4"},"previous_names":[],"tags_count":21,"template":false,"template_full_name":"ahmadnassri/template-docker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmadnassri%2Fdocker-rapidoc-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmadnassri%2Fdocker-rapidoc-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmadnassri%2Fdocker-rapidoc-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmadnassri%2Fdocker-rapidoc-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ahmadnassri","download_url":"https://codeload.github.com/ahmadnassri/docker-rapidoc-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251782776,"owners_count":21642987,"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":["docker","rapidoc","server"],"created_at":"2024-10-04T09:41:03.933Z","updated_at":"2025-04-30T21:10:30.589Z","avatar_url":"https://github.com/ahmadnassri.png","language":"HTML","funding_links":["https://github.com/sponsors/ahmadnassri"],"categories":[],"sub_categories":[],"readme":"# RapiDoc Server\n\na RapiDoc server with live monitoring and reload\n\n[![license][license-img]][license-url]\n[![release][release-img]][release-url]\n[![size][size-img]][size-url]\n[![docker][docker-img]][docker-url]\n[![github][github-img]][github-url]\n\n## Features\n\na [RapiDoc][] server that watches for changes in your spec file and automatically reloads connected browser sessions with ever spec file change.\n\n\u003e ***Note**: uses [`serve-reload-replace`][] under the hood to run the HTTP server, and **monitor** changes*\n\n## Usage\n\n###### quick start\n\n- define an environment variable `spec-url` to point to your spec file *(http url or local path)*\n- if a local path: mount your specs file(s) to `/www/`, set `spec-url` path starts with `/`\n\n###### useage with local path\n\n``` bash\n$ docker run -it -p 8080:8080 -v /path/to/petstore.yaml:/www/petstore.yaml -e \"spec-url=/spec/petstore.json\" rapidoc-server\n```\n\n###### usage with urls\n\nWhile you can use a full url to a spec file, it will not watch for changes / automatically reload.\n\n``` bash\n$ docker run -it -p 8080:8080 -e \"spec-url=https://petstore.swagger.io/v2/swagger.json\" rapidoc-server\n```\n\n###### usage with Docker Compose\n\n``` yaml\nversion: 3.8\nservices:\n  docs:\n    build: .\n    ports:\n      - 8080:8080\n    volumes:\n      - ./my-spec.json:/www/my-spec.json\n    environment:\n      spec-url: /petstore.json\n      theme: dark\n```\n\n### RapiDoc Attributes\n\nAll the [RapiDoc Attributes][] are supported through environment variables:\n\n``` bash\n$ docker run -it --rm -p 8080:8080 \\\n  -e \"spec-url=https://petstore.swagger.io/v2/swagger.json\" \\\n  -e \"show-header=false\" \\\n  -e \"show-info=false\" \\\n  -e \"allow-authentication=false\" \\\n  -e \"allow-server-selection=false\" \\\n  -e \"allow-api-list-style-selection=false\" \\\n  -e \"theme=dark\" \\\n  -e \"render-style=read\" \\\n  rapidoc-server\n```\n\n  [RapiDoc]: https://rapidocweb.com/\n  [`serve-reload-replace`]: https://github.com/ahmadnassri/node-serve-reload-replace\n  [RapiDoc Attributes]: https://rapidocweb.com/api.html\n\n----\n\u003e Author: [Ahmad Nassri](https://www.ahmadnassri.com/) \u0026bull;\n\u003e Twitter: [@AhmadNassri](https://twitter.com/AhmadNassri)\n\n[license-url]: LICENSE\n[license-img]: https://badgen.net/github/license/ahmadnassri/docker-rapidoc-server\n\n[release-url]: https://github.com/ahmadnassri/docker-rapidoc-server/releases\n[release-img]: https://badgen.net/github/release/ahmadnassri/docker-rapidoc-server\n\n[size-url]: https://hub.docker.com/r/ahmadnassri/rapidoc-server\n[size-img]: https://badgen.net/docker/size/ahmadnassri/rapidoc-server?label=image%20size\n\n[docker-url]: https://hub.docker.com/r/ahmadnassri/rapidoc-server\n[docker-img]: https://badgen.net/badge/icon/docker%20hub?icon=docker\u0026label\n\n[github-url]: https://github.com/users/ahmadnassri/packages/container/package/rapidoc-server\n[github-img]: https://badgen.net/badge/icon/github%20registry?icon=github\u0026label\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahmadnassri%2Fdocker-rapidoc-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fahmadnassri%2Fdocker-rapidoc-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahmadnassri%2Fdocker-rapidoc-server/lists"}