{"id":26217019,"url":"https://github.com/thatbeautifuldream/react-api-ref","last_synced_at":"2025-03-12T12:18:35.477Z","repository":{"id":281746383,"uuid":"946289759","full_name":"thatbeautifuldream/react-api-ref","owner":"thatbeautifuldream","description":"OpenAPI Docs Viewer","archived":false,"fork":false,"pushed_at":"2025-03-10T23:27:46.000Z","size":129,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-11T00:19:27.611Z","etag":null,"topics":["api-docs","openapi","swagger"],"latest_commit_sha":null,"homepage":"https://api.milind.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thatbeautifuldream.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2025-03-10T23:00:42.000Z","updated_at":"2025-03-10T23:29:13.000Z","dependencies_parsed_at":"2025-03-11T00:20:00.082Z","dependency_job_id":"fc4c13f6-beac-4e29-a1f9-d5b4e959c86d","html_url":"https://github.com/thatbeautifuldream/react-api-ref","commit_stats":null,"previous_names":["thatbeautifuldream/react-api-ref"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thatbeautifuldream%2Freact-api-ref","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thatbeautifuldream%2Freact-api-ref/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thatbeautifuldream%2Freact-api-ref/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thatbeautifuldream%2Freact-api-ref/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thatbeautifuldream","download_url":"https://codeload.github.com/thatbeautifuldream/react-api-ref/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243213981,"owners_count":20254902,"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-docs","openapi","swagger"],"created_at":"2025-03-12T12:18:34.965Z","updated_at":"2025-03-12T12:18:35.459Z","avatar_url":"https://github.com/thatbeautifuldream.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenAPI Documentation Viewer\n\nThis is a simple React application that renders OpenAPI/Swagger documentation using [@scalar/api-reference-react](https://github.com/scalar/scalar). The app allows you to view any OpenAPI specification by providing its URL.\n\n## Features\n\n- View OpenAPI/Swagger documentation in a modern, interactive interface\n- Default documentation loaded from Scalar's Galaxy API\n- Persists your last viewed API specification URL in localStorage\n\n## View custom docs by running this script on your console with your openapi spec url\n\n```js\nconst specUrl = \"https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.yaml\"; // replace with your spec url\nlocalStorage.setItem(\"specUrl\", specUrl);\n```\n\n## Getting Started\n\n### Prerequisites\n\n- Node.js (v14 or higher)\n- npm or yarn\n\n### Installation\n\n1. Clone this repository:\n\n```bash\ngit clone \u003cyour-repo-url\u003e\ncd \u003cyour-repo-name\u003e\n```\n\n2. Install dependencies:\n\n```bash\nnpm install\n# or\nyarn\n```\n\n3. Start the development server:\n\n```bash\nnpm run dev\n# or\nyarn dev\n```\n\nThe application will be available at `http://localhost:5173` by default.\n\n## Usage\n\nThe application will load the Scalar Galaxy API documentation by default. To view a different OpenAPI specification:\n\n1. Have your OpenAPI specification hosted somewhere accessible via URL\n2. Update the URL in the application\n3. The application will remember your last viewed specification URL\n\n## Built With\n\n- [React](https://reactjs.org/)\n- [TypeScript](https://www.typescriptlang.org/)\n- [Vite](https://vitejs.dev/)\n- [@scalar/api-reference-react](https://github.com/scalar/scalar) - For rendering OpenAPI documentation\n\n## License\n\nThis project is licensed under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthatbeautifuldream%2Freact-api-ref","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthatbeautifuldream%2Freact-api-ref","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthatbeautifuldream%2Freact-api-ref/lists"}