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.767.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3a5b193f9eb50efb7ee6bc6d57908c5cd097144d80ceed461c5739ba2ff7f708 |
|
MD5 | 41af0f1ff372e26188f4c5a5e4ce56cf |
|
BLAKE2b-256 | bc4b3d066e06cea159931c7e6fb96bfd09c4506bc02546f351ac54ba34da967a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.767-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 65dd032ea0eb7a3ee698bf0994d1fb617116498a44fb32b2f0b0d6ce1bd8ee07 |
|
MD5 | 8d19507911cdcf2c730569c1c3ce24f2 |
|
BLAKE2b-256 | d6ee9025b12e7285c1288162eb63e36dc4b95182add18963686749faf25bc88e |