{"id":22486320,"url":"https://github.com/data-fair/openapi-viewer","last_synced_at":"2026-01-31T06:30:49.412Z","repository":{"id":44125221,"uuid":"84982324","full_name":"data-fair/openapi-viewer","owner":"data-fair","description":"Browse and test a REST API described with the OpenAPI 3.0 Specification","archived":false,"fork":false,"pushed_at":"2025-12-01T21:23:15.000Z","size":2572,"stargazers_count":94,"open_issues_count":3,"forks_count":12,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-12-24T23:14:51.825Z","etag":null,"topics":["api","api-documentation","openapi","openapi3","swagger","swagger-ui"],"latest_commit_sha":null,"homepage":null,"language":"Vue","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/data-fair.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-03-14T18:12:56.000Z","updated_at":"2025-11-10T14:55:00.000Z","dependencies_parsed_at":"2024-04-10T02:56:01.625Z","dependency_job_id":"59326115-57be-44a4-a929-50bd06e788c1","html_url":"https://github.com/data-fair/openapi-viewer","commit_stats":null,"previous_names":["koumoul-dev/openapi-viewer"],"tags_count":46,"template":false,"template_full_name":null,"purl":"pkg:github/data-fair/openapi-viewer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/data-fair%2Fopenapi-viewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/data-fair%2Fopenapi-viewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/data-fair%2Fopenapi-viewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/data-fair%2Fopenapi-viewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/data-fair","download_url":"https://codeload.github.com/data-fair/openapi-viewer/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/data-fair%2Fopenapi-viewer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28931247,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-31T04:05:25.756Z","status":"ssl_error","status_checked_at":"2026-01-31T04:02:35.005Z","response_time":128,"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":["api","api-documentation","openapi","openapi3","swagger","swagger-ui"],"created_at":"2024-12-06T17:14:22.227Z","updated_at":"2026-01-31T06:30:49.386Z","avatar_url":"https://github.com/data-fair.png","language":"Vue","funding_links":["https://github.com/sponsors/koumoul-dev"],"categories":["Vue"],"sub_categories":[],"readme":"# OpenAPI viewer\n\nThis service is designed to easily browse and test a REST API described with the [OpenAPI 3.0 Specification](https://github.com/OAI/OpenAPI-Specification).\n\n## Sponsors\n\n| | Click [here to support the development of this project](https://github.com/sponsors/koumoul-dev). |\n|-|-|\n| ![Koumoul logo](https://koumoul.com/static/logo-slogan.png) | [Koumoul](https://koumoul.com) develops the Data Fair ecosystem and hosts it as an online service. |\n| ![Dawizz logo](https://dawizz.fr/logo-Dawizz-all-about-your-data-home.png) | [Dawizz](https://dawizz.fr) uses the Data Fair ecosystem inside its platform and supports its development. |\n\n## Parameters\n\n### Query Parameters\n\n- **drawerLocation** : The location of the navigation-drawer. Can be `left` or `right`. Defaults to `left`.\n- **urlType** : The type of the URL defined in the environment variable `ALLOWED_URLS`.\n- **operation** : The `operationId` of the operation to navigate to. [Reference : OpenAPI 3.1 Operation Object](https://spec.openapis.org/oas/v3.1.0#operation-object)\n\n\u003e ⚠️ **Deprecated**:\n\u003e\n\u003e - ~~**url** : The location of the API documentation file to load, in OpenAPI v3 JSON format.~~ *Replaced by the `urlType` query parameter instead and the `ALLOWED_URLS` environment variable.*\n\u003e - ~~**hide-toolbar** : `true` or `false` to hide the toolbar (useful for iframe integration). Defaults to `false`.~~\n\n### Environment Variables\n\n- **USE_SIMPLE_DIRECTORY** : A boolean to enable integration with **[SimpleDirectory](https://github.com/data-fair/simple-directory)**. Defaults to `false`.\n\n- **DEFAULT_URL** : The default URL to load when no `urlType` query parameter is provided.\n\n- **ALLOWED_URLS** : A JSON object containing a list of allowed URLs. The keys are used as the `urlType` query parameter. The values are the URLs to the OpenAPI files. These URLs can contain placeholders enclosed in curly braces {}, which will be replaced by the corresponding query parameters. The placeholders are defined by the keys of the query parameters. Defaults to an empty object.\n\n\u003e *Examples of ALLOWED_URLS :*\n\u003e\n\u003e ```json\n\u003e {\n\u003e   \"exampleYaml\": \"https://example1.com/openapi.yaml\",\n\u003e   \"exampleWithUrlTemplate\": \"https://example2.com/{id}/openapi.json\"\n\u003e }\n\u003e ```\n\n## Integration with SimpleDirectory\n\nBy default, the viewer runs in **standalone mode** and does not integrate with **[SimpleDirectory](https://github.com/data-fair/simple-directory)**.  \nHowever, you can enable integration to benefit from:\n\n- **Theming**: Automatically adapts to the platform's look and feel.\n- **Language**: Uses the same language settings as the environment.\n\nTo enable integration with SimpleDirectory, set the environment variable:\n\n```bash\nUSE_SIMPLE_DIRECTORY=true\n```\n\n## Developers\n\nTake a look at the [contribution guidelines](./CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdata-fair%2Fopenapi-viewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdata-fair%2Fopenapi-viewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdata-fair%2Fopenapi-viewer/lists"}