{"id":24951927,"url":"https://github.com/liborm85/swagger-ui-offline-packager","last_synced_at":"2026-03-15T22:45:57.048Z","repository":{"id":275172136,"uuid":"921789687","full_name":"liborm85/swagger-ui-offline-packager","owner":"liborm85","description":"Generates a self-contained HTML file from an OpenAPI definition, rendering it in Swagger UI for offline API documentation.","archived":false,"fork":false,"pushed_at":"2025-04-27T09:45:45.000Z","size":22,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-08-09T16:54:20.486Z","etag":null,"topics":["openapi","rest","rest-api","swagger","swagger-js","swagger-ui"],"latest_commit_sha":null,"homepage":"","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/liborm85.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","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}},"created_at":"2025-01-24T16:11:29.000Z","updated_at":"2025-04-27T09:45:11.000Z","dependencies_parsed_at":"2025-03-28T19:40:31.745Z","dependency_job_id":"80c56fc6-c883-4e53-bf4c-ce9fecb96e0b","html_url":"https://github.com/liborm85/swagger-ui-offline-packager","commit_stats":null,"previous_names":["liborm85/swagger-ui-offline-packager"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/liborm85/swagger-ui-offline-packager","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liborm85%2Fswagger-ui-offline-packager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liborm85%2Fswagger-ui-offline-packager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liborm85%2Fswagger-ui-offline-packager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liborm85%2Fswagger-ui-offline-packager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/liborm85","download_url":"https://codeload.github.com/liborm85/swagger-ui-offline-packager/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liborm85%2Fswagger-ui-offline-packager/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269773588,"owners_count":24473628,"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","status":"online","status_checked_at":"2025-08-10T02:00:08.965Z","response_time":71,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["openapi","rest","rest-api","swagger","swagger-js","swagger-ui"],"created_at":"2025-02-03T01:32:28.469Z","updated_at":"2025-12-27T20:23:27.255Z","avatar_url":"https://github.com/liborm85.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Swagger UI Offline Packager [![npmjs](https://img.shields.io/npm/v/swagger-ui-offline-packager.svg)](https://www.npmjs.com/package/swagger-ui-offline-packager)\n\nA tool that generates a single, self-contained HTML file from an OpenAPI definition (YAML or JSON), rendering it in Swagger UI. This allows you to view API documentation offline, without needing an internet connection or a separate web server.\n\n## Features\n- Converts OpenAPI (YAML or JSON) into a standalone Swagger UI HTML file\n- The generated file works completely offline\n- Supports loading the API definition from multiple files\n- Supports `$ref` references in OpenAPI 3.1 specifications\n- Easy to use, no external dependencies required\n\nPerfect for sharing API documentation in a simple, portable format! 🚀\n\n## Installation\n\nYou can install Swagger UI Offline Packager globally or locally using npm.\n\n**Global Installation**\n\nTo install the package globally, run:\n\n```sh\nnpm install -g swagger-ui-offline-packager\n```\nThis allows you to use the `swagger-ui-offline-packager` command anywhere in your terminal. You can also use the shorter alias `sop`.\n\n**Local Installation**\n\nTo install the package locally in your project, run:\n\n```sh\nnpm install swagger-ui-offline-packager\n```\nYou can then use it within your project scripts or via `npx`:\n\n```sh\nnpx swagger-ui-offline-packager\n```\nor with the alias:\n\n```sh\nnpx sop\n```\n\n## Usage\n\nTo generate a standalone Swagger UI HTML file, run the command with the required input file:\n```\nsop \u003cswagger-file\u003e [output-html-file]\n```\n\n**Parameters:**\n- swagger-file *(required)* – Path to the Swagger (OpenAPI) file in YAML or JSON format.\n- output-html-file *(optional)* – Path to the output HTML file. If not provided, the output file will be named based on the input file.\n\nFor more information, use:\n```sh\nsop --help\n```\n\n## Examples:\nGenerate an HTML file with the default output name (generates api.html in the same directory):\n\n```sh\nsop api.yaml\n```\n\nSpecify a custom output file:\n\n```sh\nsop api.yaml my-api-docs.html\n```\n\nUsing npx (if installed locally):\n\n```sh\nnpx sop api.json docs.html\n```\n\n## License\n\nMIT","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fliborm85%2Fswagger-ui-offline-packager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fliborm85%2Fswagger-ui-offline-packager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fliborm85%2Fswagger-ui-offline-packager/lists"}