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.909.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a61aa12bab5bb683ae03ed6165d22c6fa2abeb18a6eb6b19a46f168fe4cc110f |
|
MD5 | bc834ff76cb00fc8825b3568550b4d17 |
|
BLAKE2b-256 | 50e507f8d6a9cd4e1782918250331e8acc4b9ad2d4967025d6213fba3368c325 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.909-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eedbb2f1fa596066c208a09d9551280aad34a0bf73a63f98af6f4c2fd4171048 |
|
MD5 | 7968eea231c06271dfe7acde7fa6396c |
|
BLAKE2b-256 | 3bd10ff92ea52e97a26868bc34e29ecd2c52d73de8914476be1a20a8e2720d73 |