{"id":17809298,"url":"https://github.com/codfish/swagger-docker","last_synced_at":"2026-01-20T13:01:53.838Z","repository":{"id":52550772,"uuid":"176136771","full_name":"codfish/swagger-docker","owner":"codfish","description":"Docker image for swagger documentation app.","archived":false,"fork":false,"pushed_at":"2021-04-26T11:40:00.000Z","size":1887,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-07T14:52:06.877Z","etag":null,"topics":["docker","swagger","swagger-ui"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/codfish/swagger","language":"JavaScript","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/codfish.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}},"created_at":"2019-03-17T17:36:05.000Z","updated_at":"2021-02-20T20:03:00.000Z","dependencies_parsed_at":"2022-09-23T01:11:40.708Z","dependency_job_id":null,"html_url":"https://github.com/codfish/swagger-docker","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/codfish/swagger-docker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codfish%2Fswagger-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codfish%2Fswagger-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codfish%2Fswagger-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codfish%2Fswagger-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codfish","download_url":"https://codeload.github.com/codfish/swagger-docker/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codfish%2Fswagger-docker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28603404,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T12:01:53.233Z","status":"ssl_error","status_checked_at":"2026-01-20T12:01:46.545Z","response_time":117,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","swagger","swagger-ui"],"created_at":"2024-10-27T15:16:23.237Z","updated_at":"2026-01-20T13:01:53.819Z","avatar_url":"https://github.com/codfish.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# swagger-docker\n\nDocker image for visually rendering documentation for an API defined with the OpenAPI (Swagger)\nSpecification. Simply mount over the `/app/swagger.yaml` file with your OpenAPI spec and you'll have\na Swagger UI to view \u0026 interact with in seconds.\n\nReason for building this image is because the\n[native swagger-ui image](https://hub.docker.com/r/swaggerapi/swagger-ui/) doesn't support YAML, and\nI personally prefer writing OpenAPI documentation in YAML.\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n\n- [Usage](#usage)\n  - [With `dotdocker`](#with-dotdocker)\n- [Reference](#reference)\n- [Todo](#todo)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n## Usage\n\n\u003e NOTE: Only YAML is supported _currently_.\n\nSimply mount over `/app/swagger.yaml` with your local api spec. Example `docker-compose.yml` file:\n\n```yaml\nversion: '3'\n\nservices:\n  docs:\n    image: codfish/swagger\n    command: npm run dev\n    ports:\n      - '10010:10010'\n    volumes:\n      - ./my-api-spec.yaml:/app/swagger.yaml:delegated\n```\n\nThis will make your swagger ui docs available at `http://localhost:10010`.\n\n### With `dotdocker`\n\nIf you're interested in getting a fancy \\*.docker url and not worrying about port collisions across\nprojects check out [dotdocker](https://github.com/aj-may/dotdocker). Instead of having to expose a\nport and view the docs at `localhost:10010` for example, you can do this instead:\n\n```yaml\nversion: '3'\n\nservices:\n  docs:\n    image: codfish/swagger\n    command: npm run dev\n    volumes:\n      - ./my-api-spec.yaml:/app/swagger.yaml:delegated\n    environment:\n      VIRTUAL_HOST: docs.my-api.docker\n```\n\n1. `brew install aj-may/dotdocker/dotdocker`\n2. `sudo dotdocker start`\n3. Add `VIRTUAL_HOST` environment variable to any docker service.\n\nThat's it! You can visit the docs at `http://docs.my-api.docker/`.\n\n## Reference\n\n- **OpenAPI Specification:** \u003chttps://github.com/OAI/OpenAPI-Specification\u003e\n\n## Todo\n\n- [ ] Support multiple file types\n- [ ] Add `docker` command example to readme\n- [ ] Add support for swagger-ui options\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodfish%2Fswagger-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodfish%2Fswagger-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodfish%2Fswagger-docker/lists"}