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.473.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c15d1533ecaf44708cc152ffc5611a0f5b6bdea88c9c0255c7e0ea569462a88b |
|
MD5 | 24ebe7868cd5f05da942758c58ed965c |
|
BLAKE2b-256 | 3e66ecdefc659f28a8f222a5b08657dcf0096702b590af12681110572b29c46b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.473-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e5fd9210a131302148f0cb6f6d7034c5d07487ce27f9870d937d37ff33a1bc66 |
|
MD5 | 2d0b2a8032aef4f67041f33d39f42a0b |
|
BLAKE2b-256 | 84b698f160f80fbf08440b349276b86b727061148472adc87f8c7ef2262dc104 |