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.549.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2bb5196c8afb96dc94fba1f1794be7e7c2df368eef4faf65b05373acf647a057 |
|
MD5 | 06309a9838d868be7a4519b9c45fc47a |
|
BLAKE2b-256 | 1a68831162d3d853de57401aabea6383d98803c96d49ae31518c5ca7dab90088 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.549-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 08bd09c8299bd5235a055ddc4a6ba69407ae97951f7f6f6e3292addea4e29d37 |
|
MD5 | 67f527d4669efad998283f37e05031f3 |
|
BLAKE2b-256 | 272a40ab56c796fe55cb2665332e861cade3b7047e6a78b7f9baf4a2bc088d25 |