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.540.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 634c2621ba4aa72aa5f0aa9a0bc6841c8132cb06f631cf79b9de62fc86682d1f |
|
MD5 | 63fb9fcc27e8eaf457b87412cc7e4d26 |
|
BLAKE2b-256 | f2d46d2bfc9322c1c86469ba6332f85645835caf55a35bc2d0dd84fff50f47d9 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.540-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d5c70bc097acab8d7dc9e1e5e2ee76217682f421f74228bae3bd08e7feb64dce |
|
MD5 | 8543b1812aa2bb423a32b91c92462a29 |
|
BLAKE2b-256 | 996b2322bdffecd6bd7f7ecc43c9d08c81fe511c0492af88cf4e5fe0f7c3e52f |