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.644.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e8a2b873684ad15928656d44dba9eb2ba4cdc37f6551897301b6be807a504038 |
|
MD5 | 3e4763ac0c3631a8d83e8cee27891dc8 |
|
BLAKE2b-256 | 7c089906990fd0949a72819710b6d1bb7dd0e8c62463fb560cd4ed28f17aa4d8 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.644-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1be2a79e22deee6a442416bc8c482ec401afb30b589264fb8258c0cb75d882cc |
|
MD5 | 6b571f47aa31ba0cf350be89ad2a5788 |
|
BLAKE2b-256 | 947129ea3adefd2be428a0d474be886b62baac0357abf2b81571adb12ff199fe |