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.24.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 446ee478eaa33ddae7ec9df4ac4f3d37e822d835266a8ac1df44c0cfa044f22f |
|
MD5 | 2f4e0e3d16e49392fb5205aead2886ac |
|
BLAKE2b-256 | 71fd4bdfc1472d75a10bf2f0e5be51d7e1d4410f6f4deeb86242ae8bbed3ddc8 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.24-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 121c75ec706a3b22c58de071caa21af856db9914dc5343a4eb8c1a214f38df81 |
|
MD5 | 53274abeea658e68abe2c6facc4c585a |
|
BLAKE2b-256 | a4f1b8c1c3486d7d267e810a2363316dca4392c5362f38a51c10214780df54f4 |