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.347.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6aa309e9540e32cf783557ec9ed95cd35770a98f8b35d14812a4196dd731fa31 |
|
MD5 | 2b53f822dc71b76afab3a4eaf10b3dc8 |
|
BLAKE2b-256 | 6368d2e52c5f01777b25d3b37cae830aae60b35b86b952d6e5d19eaca400c4b4 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.347-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a19f5436add92a8031364a5df910992ac66b0f10f1fbe1be939f6bdf91d5b02a |
|
MD5 | 44258637418d762453230f440ae6d9a3 |
|
BLAKE2b-256 | 47fff1ade6ced7db968cb8f9af525bb9265e18c2d3a2cbb2513edf76dfcc135d |