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.721.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3562d81b56e86ee18d855ca45293fdbf80c4a10858f5974635b3e003c8f3d65f |
|
MD5 | 667914c17473e704a832184c785e023e |
|
BLAKE2b-256 | 822d9f31f90d3fc6e78108cc6482f68126963260c39bfe0d9b5c72b7a337c9cb |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.721-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7fc661c2ad9aef793286835b383af9d9eeedff8f6fc8de35cd4e84801f4e40a |
|
MD5 | 2f7efd0f491fc56e0b208d97f0482cf5 |
|
BLAKE2b-256 | 83f8d3f499a41732b06eb714ba9a78ed89332a47be53c966b849e6e0ced344e5 |