{"id":14986603,"url":"https://github.com/swaggerql/swagger-combine-ui","last_synced_at":"2025-04-11T20:32:13.544Z","repository":{"id":42095159,"uuid":"241923423","full_name":"swaggerql/swagger-combine-ui","owner":"swaggerql","description":"Combines multiple Swagger schemas into one site","archived":false,"fork":false,"pushed_at":"2024-09-11T21:45:11.000Z","size":720,"stargazers_count":6,"open_issues_count":4,"forks_count":7,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-25T18:21:18.308Z","etag":null,"topics":["api","documentation","open-api","rest-api","swagger","swagger-api","swagger-ui"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/swaggerql/swagger-combine-ui","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/swaggerql.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2020-02-20T15:46:41.000Z","updated_at":"2025-02-05T10:05:54.000Z","dependencies_parsed_at":"2023-01-31T15:00:50.868Z","dependency_job_id":"fdbd8fc9-0b93-4488-8839-6fb178915629","html_url":"https://github.com/swaggerql/swagger-combine-ui","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swaggerql%2Fswagger-combine-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swaggerql%2Fswagger-combine-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swaggerql%2Fswagger-combine-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swaggerql%2Fswagger-combine-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/swaggerql","download_url":"https://codeload.github.com/swaggerql/swagger-combine-ui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248476425,"owners_count":21110279,"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":["api","documentation","open-api","rest-api","swagger","swagger-api","swagger-ui"],"created_at":"2024-09-24T14:13:12.890Z","updated_at":"2025-04-11T20:32:08.525Z","avatar_url":"https://github.com/swaggerql.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Swagger Combine UI\n[![Build Status](https://github.com/swaggerql/swagger-combine-ui/actions/workflows/build.yml/badge.svg)](https://github.com/swaggerql/swagger-combine-ui/actions/workflows/build.yml)\n[![CodeQL](https://github.com/swaggerql/swagger-combine-ui/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/swaggerql/swagger-combine-ui/actions/workflows/codeql-analysis.yml)\n[![Docker swagger-combine-ui](https://img.shields.io/badge/docker-swagger--combine--ui-green)](https://hub.docker.com/r/swaggerql/swagger-combine-ui)\n\nThe service is used to combine the documentation of various services and display it.\n\nWhen you should use `swagger-combine-ui`:\n- You have a certain number of microservices and you need to combine their Swagger into one interface\n\n![Scheme](https://raw.githubusercontent.com/swaggerql/swagger-combine-ui/master/scheme.png)\n\n## Usage\n\nCheckout this repository locally, then:\n\n```sh\nnpm i\nnpm start\n```\n\nNow you can visit [http://localhost:3000](http://localhost:3000) to view your server.\n\n### Docker\n\nRun `swagger-combine-ui` with a custom config file:\n\n```sh\ndocker run -d -p 3000:3000 -v /path/to/swagger.yaml:/app/swagger.yaml swaggerql/swagger-combine-ui\n```\n\n## Configuration\n\nThe default path for the configuration file is `./swagger.yaml`\n\nSwagger Combine UI requires one configuration schema which resembles a standard Swagger schema except for an additional `apis` field.\n\nFor informations about configuration have a look at the documentation of [swagger-combine](https://github.com/maxdome/swagger-combine#configuration).\n\n### Configuration example\n\n#### swagger.yaml\n\n```yaml\nswagger: '2.0'\ninfo:\n  title: Basic Swagger Combine Example\n  version: 1.0.0\napis:\n- url: http://petstore.swagger.io/v2/swagger.json\n- url: https://api.apis.guru/v2/specs/medium.com/1.0.0/swagger.json\n- url: https://api.apis.guru/v2/specs/deutschebahn.com/betriebsstellen/v1/swagger.json\n  paths:\n    base: /bahn\n```\n\n### APIs difference\n\n#### `url` field\n\nURL or query path to swagger apidocs.\nIf the `url` field contains a path, then the full url is formed from the request headers:\n- `Host` header is used as the domain.\n- `X-Forwarded-Proto` header is used as a schema. Schema is `http` by default.\n\n## License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswaggerql%2Fswagger-combine-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fswaggerql%2Fswagger-combine-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswaggerql%2Fswagger-combine-ui/lists"}