Add SwaggerUI to your AWS Apigateway RestApi
Project description
CDK Apigateway SwaggerUI
Add SwaggerUI to your AWS Apigateway RestApi
Install
TypeScript
npm install @pepperize/cdk-apigateway-swagger-ui
or
yarn add @pepperize/cdk-apigateway-swagger-ui
Python
pip install pepperize.cdk-apigateway-swagger-ui
C# / .Net
dotnet add package Pepperize.CDK.ApigatewaySwaggerUi
Java
<dependency>
<groupId>com.pepperize</groupId>
<artifactId>cdk-apigateway-swagger-ui</artifactId>
<version>${cdkApigatewaySwaggerUi.version}</version>
</dependency>
Usage
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for pepperize.cdk-apigateway-swagger-ui-0.0.240.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0dd116dc1dc37134ccde65f14e26bbc75ee5222f3c0770170049c23952361f91 |
|
MD5 | b0374fdf67c9d706f2d38c77fcf41c48 |
|
BLAKE2b-256 | 753178c838ef2dd9b3ec05cdfd55212f7b0ccefb84125685093ca36f481ea026 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.240-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 840577196dda0b64bbd746cb35ed52be2c093f606a783d939a51b47996baf317 |
|
MD5 | 590d09c7cef9a43741cc5d265049239e |
|
BLAKE2b-256 | c9c5f9e56d341e37867b00e2abf985295b3b5a413bc6363d0f0a41af6ea466e6 |