{"id":29661852,"url":"https://github.com/payu/swaggipedia","last_synced_at":"2025-07-22T10:37:59.449Z","repository":{"id":187964112,"uuid":"675607750","full_name":"PayU/swaggipedia","owner":"PayU","description":"Lightweight open-source platform for browsing swagger APIs","archived":false,"fork":false,"pushed_at":"2023-11-29T10:30:58.000Z","size":3462,"stargazers_count":17,"open_issues_count":4,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-05-16T22:14:05.156Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/PayU.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}},"created_at":"2023-08-07T10:05:03.000Z","updated_at":"2025-03-25T10:10:34.000Z","dependencies_parsed_at":null,"dependency_job_id":"9ac404e6-e9ef-4492-9b94-487ec86cc73a","html_url":"https://github.com/PayU/swaggipedia","commit_stats":null,"previous_names":["payu/swaggipedia"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/PayU/swaggipedia","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PayU%2Fswaggipedia","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PayU%2Fswaggipedia/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PayU%2Fswaggipedia/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PayU%2Fswaggipedia/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PayU","download_url":"https://codeload.github.com/PayU/swaggipedia/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PayU%2Fswaggipedia/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266477152,"owners_count":23935390,"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-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"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":[],"created_at":"2025-07-22T10:37:58.595Z","updated_at":"2025-07-22T10:37:59.433Z","avatar_url":"https://github.com/PayU.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Swaggipedia \n## Lightweight open-source platform for browsing swagger APIs.\n\nSwaggipedia provides a simple REST API alongside a user-friendly UI to manage and browse your APIs.\n\n-----------------------------------------------------\n## Quick View\n![swaggipedia](https://github.com/PayU/swaggipedia/assets/11981986/3c61e142-c115-4977-b206-5c30c815a4ab)\n\n\u003cbr/\u003e\n\u003cbr/\u003e\n\n## How to use Swaggipedia\n\n### **Step 1**: start a swaggipedia server instance\nSwaggipedia is production ready and can be deployed using Docker. Starting an instance is simple:\n```sh\ndocker run -d -p 3000:3000 --name my-swaggipedia zooz/swaggipedia\n```\n\n**Configuring Swaggipedia**:\n\u003e There are a small number of environment variables supported by the image:\n\u003e - **LOG_LEVEL**: *One of: 'trace' | 'debug' | 'info' (Default) | 'warn' | 'error' | 'fatal'.*\n\u003e - **DATABASE_TYPE**: *One of: 'sqlite' (Default) | 'mysql' | 'postgres' | 'mariadb' | 'mssql' | 'oracle'.*\n\u003e - **DATABASE_ADDRESS**: *The host of the database.*\n\u003e - **DATABASE_NAME**: *The name of the database.*\n\u003e - **DATABASE_USERNAME**: *The username used to authenticate against the database.*\n\u003e - **DATABASE_PASSWORD**: *The password used to authenticate against the database. Supports SQLCipher encryption for SQLite.*\n\u003e - **SQLITE_STORAGE_PATH**: *The storage engine for sqlite (Only used by sqlite). Defaults to './db/swaggipedia.sqlite'.*\n\u003e - **APP_BASE_NAME**: *Enables tweaking the public folder containing the HTML file (Swaggipedia UI).*\n\u003e - **SECRETS_FILE_PATH**: *Path to a JSON file inside your Swaggipedia container that contains the application's secrets 'DATABASE_USERNAME' \u0026 'DATABASE_PASSWORD'. (Commonly used by secrets management tools).*\n\n\n\u003cbr/\u003e\n\n### **Step 2**: manage the swagger files using swaggipedia API\nSwaggipedia provides a super simple REST API to get/create/update/delete swagger files. [API Reference](https://payu.github.io/swaggipedia/)\n\n\u003cbr/\u003e\n\n### **Step 3**: browse your swagger using swaggipedia UI\n```\u003cYOUR_SERVER_URL\u003e/ui```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpayu%2Fswaggipedia","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpayu%2Fswaggipedia","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpayu%2Fswaggipedia/lists"}