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.49.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a278a4d860e13566b1f029de341ef61d2791196a6c3d6759bff18e5455fd802b |
|
MD5 | 26a9513aac4473b16117d964f6aaf657 |
|
BLAKE2b-256 | f6bd74e2d4c3923cd43745ab426b557dea359ab207044e913c310a6b67edd788 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.49-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d941230e1487c3e2d1d37b60750c6e1beb9fc84b856be1da5f1d7ae008556fa7 |
|
MD5 | 18f7491af028eb2ba120aaaa4676acbb |
|
BLAKE2b-256 | ae34764b217b4f67bfbb87e61bab00922f4352825db68607b0cbb9fe5d1a37fc |