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.117.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca2e492ec4a01c550ef2c1f2af3100097ac067bc9bd99aa326c3a3f29b16a109 |
|
MD5 | 704131d3c56cbf02ff04a09abdae4714 |
|
BLAKE2b-256 | ded37b213fc8810e05ab7da97fd727b773c02378daaef27f0dc0ca7444124b64 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.117-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 787f5c7b28fa6f8765a70433cbc155a422c268e0fb0f2411ad55a74f9b54fd66 |
|
MD5 | 0d30f5218c83aa640cf4cb95e71d10b0 |
|
BLAKE2b-256 | 1db95dbb6e3ddd47fbbc88b3832724b8e6f1fc9d93da1d21f303870d9cdc631e |