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.806.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d1cddd6d801e604ee88aec62024a3b9e5ffdac8c62655b2292f1ebc5fc47add |
|
MD5 | ace21f44c938dfa76ed3bc32cbb198f4 |
|
BLAKE2b-256 | 0f795147362b81593c7118156d58c1511da0bc170bb44a13b725e84a756c39e9 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.806-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0285fe0ea406c496625b9074d43dc7b0023ff11ae69d5480087ba12a898232ac |
|
MD5 | 2710072a30bfc46df5b1271e43cff8e3 |
|
BLAKE2b-256 | ae192bdd169a657118af09496edfabc4aaf78129a95adc5292091169c1ead779 |