{"id":24879300,"url":"https://github.com/dhcode/openapi-ui","last_synced_at":"2025-07-20T02:11:17.801Z","repository":{"id":35142085,"uuid":"204203515","full_name":"dhcode/openapi-ui","owner":"dhcode","description":"Auto generated UI for OpenAPI 3 and Swagger 2 specifications","archived":false,"fork":false,"pushed_at":"2023-01-07T09:02:11.000Z","size":18698,"stargazers_count":17,"open_issues_count":28,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-22T15:05:45.438Z","etag":null,"topics":["openapi","openapi-ui","swagger"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/dhcode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-08-24T19:32:58.000Z","updated_at":"2025-05-13T11:42:56.000Z","dependencies_parsed_at":"2023-01-15T14:40:45.895Z","dependency_job_id":null,"html_url":"https://github.com/dhcode/openapi-ui","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/dhcode/openapi-ui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dhcode%2Fopenapi-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dhcode%2Fopenapi-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dhcode%2Fopenapi-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dhcode%2Fopenapi-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dhcode","download_url":"https://codeload.github.com/dhcode/openapi-ui/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dhcode%2Fopenapi-ui/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266057197,"owners_count":23870122,"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":["openapi","openapi-ui","swagger"],"created_at":"2025-02-01T10:16:03.614Z","updated_at":"2025-07-20T02:11:17.768Z","avatar_url":"https://github.com/dhcode.png","language":"TypeScript","readme":"# OpenAPI UI\n\n[![CircleCI](https://img.shields.io/circleci/build/gh/dhcode/openapi-ui.svg)](https://circleci.com/gh/dhcode/openapi-ui)\n[![Codecov](https://img.shields.io/codecov/c/github/dhcode/openapi-ui.svg)](https://codecov.io/gh/dhcode/openapi-ui)\n\nA documentation UI and API Console with focus on [Swagger v2 and OpenAPI v3 RESTful API specifications](https://swagger.io/specification/).\n\nThis UI is inspired by the [Swagger UI](https://github.com/swagger-api/swagger-ui) project, but is more focused on doing API requests.\n\n**[Demo](https://dhcode.github.io/openapi-ui/)**\n\nIt is developed as Angular Library and Angular App.\n\n## Current state\n\nThis project is in its early stages. You can try it out and see if it works with your API specification.\n\nIf you find any issues please report them. Thank you.\n\n## Usage of the Web component (custom element)\n\nSee [Web component README](projects/openapi-viewer-element/README.md)\n\n```html\n\u003coav-openapi-viewer-element\n  specurl=\"https://petstore.swagger.io/v2/swagger.json\"\n  settings='{\"showRawOperationDefinition\":true}'\n\u003e\u003c/oav-openapi-viewer-element\u003e\n\u003cscript src=\"//unpkg.com/@dhcode/openapi-viewer-element/openapi-viewer-element-es2015.js\" type=\"module\"\u003e\u003c/script\u003e\n\u003cscript src=\"//unpkg.com/@dhcode/openapi-viewer-element/openapi-viewer-element-es5.js\" nomodule defer\u003e\u003c/script\u003e\n```\n\n\n## Usage of the Angular Library\n\nSee [Angular library README](projects/openapi-viewer/README.md)\n\n\n## Usage of the Angular App (for development)\n\n    git clone https://github.com/dhcode/openapi-ui.git\n    npm install\n    npm run start\n\nOpen [localhost:4200](http://localhost:4200)\n\n\n## Browser Compatibility\n\nThis project aims to support the most common browsers.\n\n- Chrome\n- Firefox\n- Safari\n- Internet Explorer 11\n- Microsoft Edge\n\n## Not supported features\n\n- Example values for XML\n\n## TODO\n\n- Integrate support for [links](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#linkObject)\n- Show generated commandline for curl\n- Show generated code for JavaScript and other languages\n- Increase test coverage\n- Publish library to npm\n\n## Other libraries used\n\n- [ngx-ace-wrapper](https://github.com/zefoy/ngx-ace-wrapper) + [brace](https://github.com/thlorenz/brace) + [ace](https://github.com/ajaxorg/ace) to show nicely formatted code\n- [ngx-markdown](https://github.com/jfcere/ngx-markdown) + [marked](https://github.com/markedjs/marked) to show nicely formatted descriptions, if markdown was used in a specification\n- [swagger-client](https://github.com/swagger-api/swagger-js) to parse specifications and to create HTTP requests based on parameters\n- [openapi3-ts](https://github.com/metadevpro/openapi3-ts) for OpenAPI specification typings\n\n## License\n\n[MIT](LICENSE)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdhcode%2Fopenapi-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdhcode%2Fopenapi-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdhcode%2Fopenapi-ui/lists"}