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.421.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b12eed50091853345c8b4eb4f72c41cc7d7d7e3324103d2d9574d35100d88a16 |
|
MD5 | 89144c6c90b06736f6571b83380d3f6b |
|
BLAKE2b-256 | e13fc74b2c3448b504122f9c927ff9edacf3518e1b3906df8301df1e2e436d8e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.421-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e3f0aa4f6f51c9165a18a13747e5973536c716baee55d110a39166e089a7014b |
|
MD5 | e5643b0f5b0541e867b2175996d5842f |
|
BLAKE2b-256 | 406b8829e95fcf6db8fe8632ef859095d80a0f6c8ef59215e21d94dfed87d2b7 |