{"id":21127301,"url":"https://github.com/pepperize/cdk-apigateway-swagger-ui","last_synced_at":"2025-04-28T13:32:23.165Z","repository":{"id":60642229,"uuid":"544434154","full_name":"pepperize/cdk-apigateway-swagger-ui","owner":"pepperize","description":"Add SwaggerUI to your AWS Apigateway RestApi","archived":false,"fork":false,"pushed_at":"2025-04-21T08:03:15.000Z","size":8463,"stargazers_count":18,"open_issues_count":2,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-21T08:30:25.513Z","etag":null,"topics":["apigateway","aws","cdk","openapi","swagger-ui"],"latest_commit_sha":null,"homepage":"","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/pepperize.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-10-02T13:22:12.000Z","updated_at":"2025-04-21T07:57:23.000Z","dependencies_parsed_at":"2023-11-30T07:29:14.130Z","dependency_job_id":"67f2ab63-ee33-4b3d-8a36-ffcb7c965bf8","html_url":"https://github.com/pepperize/cdk-apigateway-swagger-ui","commit_stats":{"total_commits":1218,"total_committers":5,"mean_commits":243.6,"dds":"0.041871921182266014","last_synced_commit":"17aa028f5e6477ca05e569748a080edc0db72279"},"previous_names":[],"tags_count":1263,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pepperize%2Fcdk-apigateway-swagger-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pepperize%2Fcdk-apigateway-swagger-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pepperize%2Fcdk-apigateway-swagger-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pepperize%2Fcdk-apigateway-swagger-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pepperize","download_url":"https://codeload.github.com/pepperize/cdk-apigateway-swagger-ui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251319785,"owners_count":21570456,"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":["apigateway","aws","cdk","openapi","swagger-ui"],"created_at":"2024-11-20T04:48:17.251Z","updated_at":"2025-04-28T13:32:23.101Z","avatar_url":"https://github.com/pepperize.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)\n[![GitHub](https://img.shields.io/github/license/pepperize/cdk-apigateway-swagger-ui?style=flat-square)](https://github.com/pepperize/cdk-apigateway-swagger-ui/blob/main/LICENSE)\n[![npm (scoped)](https://img.shields.io/npm/v/@pepperize/cdk-apigateway-swagger-ui?style=flat-square)](https://www.npmjs.com/package/@pepperize/cdk-apigateway-swagger-ui)\n[![PyPI](https://img.shields.io/pypi/v/pepperize.cdk-apigateway-swagger-ui?style=flat-square)](https://pypi.org/project/pepperize.cdk-apigateway-swagger-ui/)\n[![Nuget](https://img.shields.io/nuget/v/Pepperize.CDK.ApigatewaySwaggerUi?style=flat-square)](https://www.nuget.org/packages/Pepperize.CDK.ApigatewaySwaggerUi/)\n[![Sonatype Nexus (Releases)](https://img.shields.io/nexus/r/com.pepperize/cdk-apigateway-swagger-ui?server=https%3A%2F%2Fs01.oss.sonatype.org%2F\u0026style=flat-square)](https://s01.oss.sonatype.org/content/repositories/releases/com/pepperize/cdk-apigateway-swagger-ui/)\n[![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/pepperize/cdk-apigateway-swagger-ui/release.yml?branch=main\u0026label=release\u0026style=flat-square)](https://github.com/pepperize/cdk-apigateway-swagger-ui/actions/workflows/release.yml)\n[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/pepperize/cdk-apigateway-swagger-ui?sort=semver\u0026style=flat-square)](https://github.com/pepperize/cdk-apigateway-swagger-ui/releases)\n[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod\u0026style=flat-square)](https://gitpod.io/#https://github.com/pepperize/cdk-apigateway-swagger-ui)\n\n# CDK Apigateway SwaggerUI\n\nAdd SwaggerUI to your AWS Apigateway RestApi\n\n![SwaggerUI Example](./images/swagger-ui-example.png)\n\n## Install\n\n### TypeScript\n\n```shell\nnpm install @pepperize/cdk-apigateway-swagger-ui\n```\n\nor\n\n```shell\nyarn add @pepperize/cdk-apigateway-swagger-ui\n```\n\n### Python\n\n```shell\npip install pepperize.cdk-apigateway-swagger-ui\n```\n\n### C\\# / .Net\n\n```\ndotnet add package Pepperize.CDK.ApigatewaySwaggerUi\n```\n\n### Java\n\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003ecom.pepperize\u003c/groupId\u003e\n  \u003cartifactId\u003ecdk-apigateway-swagger-ui\u003c/artifactId\u003e\n  \u003cversion\u003e${cdkApigatewaySwaggerUi.version}\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n## Usage\n\n```typescript\nimport { Stack } from \"aws-cdk-lib\";\nimport * as apigateway from \"aws-cdk-lib/aws-apigateway\";\nimport { SwaggerUi } from \"@pepperize/cdk-apigateway-swagger-ui\";\n\nconst stack = new Stack();\nconst restApi = new apigateway.RestApi();\n\nnew SwaggerUi(stack, \"SwaggerUI\", { resource: restApi.root });\n```\n\n- Open your SwaggerUI: `https://\u003crest api id\u003e.execute-api.\u003caws region\u003e.amazonaws.com/\u003cstage\u003e/api-docs/swagger-ui.html`\n- View your API docs: `https://\u003crest api id\u003e.execute-api.\u003caws region\u003e.amazonaws.com/\u003cstage\u003e/api-docs.json`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpepperize%2Fcdk-apigateway-swagger-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpepperize%2Fcdk-apigateway-swagger-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpepperize%2Fcdk-apigateway-swagger-ui/lists"}