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.289.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dacc2f3f76b9a45e487300f50fa6ce31ad356489b84ec17256453d65542fb232 |
|
MD5 | 82d3d11ffda036da97544458d75d885c |
|
BLAKE2b-256 | 12cfb8df15c93735a9662dff8f6030845bbdc46f33743cd6c28d100f0e45b1e7 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.289-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a0034515a334e5dad898a79643f01a7cb61043c2cb7491ba89ecf0eb7584eb91 |
|
MD5 | 9696017efa1efbf2f50fc68e38d75081 |
|
BLAKE2b-256 | be9e23d24947f404eb97ec6f9c7941f0c39d0e7662533c662240e897e52e3277 |