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.770.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 160ddf9e7cebd0f4d688a56e6261bdc22ac513a7084aadb598689253aaa5668e |
|
MD5 | 7729c08b2a755af74737dbe60e2d5b11 |
|
BLAKE2b-256 | 9cf862c4e6aa7afa70bd0c178b4d744ef0f1414876e0f249be14256b24be1e07 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.770-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8348401deb3834436a03ff92ceb8006bd5df6cf6e043f1da43b39b7daad51e78 |
|
MD5 | 059181003c76d82dc919d7dc645965dc |
|
BLAKE2b-256 | 57775b7e6e9da86a2740b7ebdf64aef7d5bcebba1609ba745de542ccb4671f92 |