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.663.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 72f81afbba00aeb01e86039a7182a7305ed62a95961c01e17239e89d94c37779 |
|
MD5 | af34447d1c2cd09d3d1dc43b9f7d8738 |
|
BLAKE2b-256 | b920188a81dc13b034688bb575408b5008aba8e59ac8045ff58ae2dd230e67ec |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.663-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4b2e19d88da0c3ebfb59a40f015b7664c492fb4571760a090059b16096939ad9 |
|
MD5 | b9b26b77f76cd4ef56430030e84e6d42 |
|
BLAKE2b-256 | 8b28f29d0bb67947ab1268f788807835c7c0163720fd4755099aec1816966fb7 |