pepperize.cdk-apigateway-swagger-ui

Name	pepperize.cdk-apigateway-swagger-ui JSON
Version	0.0.931 JSON
	download
home_page	https://github.com/pepperize/cdk-apigateway-swagger-ui.git
Summary	Add SwaggerUI to your AWS Apigateway RestApi
upload_time	2024-01-01 06:56:22
maintainer
docs_url	None
author	Patrick Florek<patrick.florek@gmail.com>
requires_python	~=3.8
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
[![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)
[![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)
[![PyPI](https://img.shields.io/pypi/v/pepperize.cdk-apigateway-swagger-ui?style=flat-square)](https://pypi.org/project/pepperize.cdk-apigateway-swagger-ui/)
[![Nuget](https://img.shields.io/nuget/v/Pepperize.CDK.ApigatewaySwaggerUi?style=flat-square)](https://www.nuget.org/packages/Pepperize.CDK.ApigatewaySwaggerUi/)
[![Sonatype Nexus (Releases)](https://img.shields.io/nexus/r/com.pepperize/cdk-apigateway-swagger-ui?server=https%3A%2F%2Fs01.oss.sonatype.org%2F&style=flat-square)](https://s01.oss.sonatype.org/content/repositories/releases/com/pepperize/cdk-apigateway-swagger-ui/)
[![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/pepperize/cdk-apigateway-swagger-ui/release.yml?branch=main&label=release&style=flat-square)](https://github.com/pepperize/cdk-apigateway-swagger-ui/actions/workflows/release.yml)
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/pepperize/cdk-apigateway-swagger-ui?sort=semver&style=flat-square)](https://github.com/pepperize/cdk-apigateway-swagger-ui/releases)
[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod&style=flat-square)](https://gitpod.io/#https://github.com/pepperize/cdk-apigateway-swagger-ui)

# CDK Apigateway SwaggerUI

Add SwaggerUI to your AWS Apigateway RestApi

![SwaggerUI Example](./images/swagger-ui-example.png)

## Install

### TypeScript

```shell
npm install @pepperize/cdk-apigateway-swagger-ui
```

or

```shell
yarn add @pepperize/cdk-apigateway-swagger-ui
```

### Python

```shell
pip install pepperize.cdk-apigateway-swagger-ui
```

### C# / .Net

```
dotnet add package Pepperize.CDK.ApigatewaySwaggerUi
```

### Java

```xml
<dependency>
  <groupId>com.pepperize</groupId>
  <artifactId>cdk-apigateway-swagger-ui</artifactId>
  <version>${cdkApigatewaySwaggerUi.version}</version>
</dependency>
```

## Usage

```python
import { Stack } from "aws-cdk-lib";
import * as apigateway from "aws-cdk-lib/aws-apigateway";
import { SwaggerUi } from "@pepperize/cdk-apigateway-swagger-ui";

const stack = new Stack();
const restApi = new apigateway.RestApi();

new SwaggerUi(stack, "SwaggerUI", { resource: restApi.root });
```

* Open your SwaggerUI: `https://<rest api id>.execute-api.<aws region>.amazonaws.com/<stage>/api-docs/swagger-ui.html`
* View your API docs: `https://<rest api id>.execute-api.<aws region>.amazonaws.com/<stage>/api-docs.json`

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/pepperize/cdk-apigateway-swagger-ui.git",
    "name": "pepperize.cdk-apigateway-swagger-ui",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "~=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "Patrick Florek<patrick.florek@gmail.com>",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/74/1a/e0a048b580e516e4a5e6cd74acb3b9d281b0ff9273bfbc1785fbcdd31c57/pepperize.cdk-apigateway-swagger-ui-0.0.931.tar.gz",
    "platform": null,
    "description": "[![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&style=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&label=release&style=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&style=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&style=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<dependency>\n  <groupId>com.pepperize</groupId>\n  <artifactId>cdk-apigateway-swagger-ui</artifactId>\n  <version>${cdkApigatewaySwaggerUi.version}</version>\n</dependency>\n```\n\n## Usage\n\n```python\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://<rest api id>.execute-api.<aws region>.amazonaws.com/<stage>/api-docs/swagger-ui.html`\n* View your API docs: `https://<rest api id>.execute-api.<aws region>.amazonaws.com/<stage>/api-docs.json`\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Add SwaggerUI to your AWS Apigateway RestApi",
    "version": "0.0.931",
    "project_urls": {
        "Homepage": "https://github.com/pepperize/cdk-apigateway-swagger-ui.git",
        "Source": "https://github.com/pepperize/cdk-apigateway-swagger-ui.git"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f9b24f89f0923d847e7bf6a800d253f5b933bda139cb2270ea8c9756987fb00d",
                "md5": "7319e4480922f8924efdb53dd1036a94",
                "sha256": "6189c94d5ff5015634e2dba443c20549acea583ed9c5e44594aad360ff63901d"
            },
            "downloads": -1,
            "filename": "pepperize.cdk_apigateway_swagger_ui-0.0.931-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7319e4480922f8924efdb53dd1036a94",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "~=3.8",
            "size": 3641124,
            "upload_time": "2024-01-01T06:56:15",
            "upload_time_iso_8601": "2024-01-01T06:56:15.920953Z",
            "url": "https://files.pythonhosted.org/packages/f9/b2/4f89f0923d847e7bf6a800d253f5b933bda139cb2270ea8c9756987fb00d/pepperize.cdk_apigateway_swagger_ui-0.0.931-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "741ae0a048b580e516e4a5e6cd74acb3b9d281b0ff9273bfbc1785fbcdd31c57",
                "md5": "c03500806c883825c60e4bfc820ddf81",
                "sha256": "c00bf3dc4a765994650f97ef46420b5da76c858311d74ae31fb282e88576431a"
            },
            "downloads": -1,
            "filename": "pepperize.cdk-apigateway-swagger-ui-0.0.931.tar.gz",
            "has_sig": false,
            "md5_digest": "c03500806c883825c60e4bfc820ddf81",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "~=3.8",
            "size": 3640613,
            "upload_time": "2024-01-01T06:56:22",
            "upload_time_iso_8601": "2024-01-01T06:56:22.593416Z",
            "url": "https://files.pythonhosted.org/packages/74/1a/e0a048b580e516e4a5e6cd74acb3b9d281b0ff9273bfbc1785fbcdd31c57/pepperize.cdk-apigateway-swagger-ui-0.0.931.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-01 06:56:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "pepperize",
    "github_project": "cdk-apigateway-swagger-ui",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pepperize.cdk-apigateway-swagger-ui"
}