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.837.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67bf5559b10c45fa90f50b2537fe806f98d2a78188811212edc658bcc41b948c |
|
MD5 | 2ec9106a56651c3f89beba21e0284e55 |
|
BLAKE2b-256 | 18febca7cebe1b27734eb2d9d4e68350a9889b75662c332511ba2e7a19d2e221 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.837-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 785635732d2390acfca66a44accdbd9a12f9fd70c39e0ea2f5b744441f469b74 |
|
MD5 | f07daa73da6d814b34bb6dd4ee2f475e |
|
BLAKE2b-256 | 4be21aa8f8cfdb8def9d5cbe4226506e780bb53db8ae36f5654ab539a33e99e5 |