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.701.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 26ec960a30da8f3a56e296460d2353c5ebc863a2d70589e8ebfa2e804d84cd87 |
|
MD5 | 53dcfb0afb0ad32e6b0feb0db6ffa76a |
|
BLAKE2b-256 | 4ad61f631bd8173789ba6faf56c7c419086371a21599e60defd02e0d9a9b2fd8 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.701-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dfb0610c8fe1962e3b4c91d98eb393d8d29ea379f1855f022de8c81d09230812 |
|
MD5 | 678d6d5b737585a7781d691618d5aac6 |
|
BLAKE2b-256 | 5d976dd6d366a0f54ea4116b9fd18c1ac5d2b9c560d730b4c3d6b2725550e145 |