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.12.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f85a0332ebbaf4246b23ac90c2dd15a3e5774947e184d7380c870ce76f55faee |
|
MD5 | 9dba8048a52932606ba3dd7638d11129 |
|
BLAKE2b-256 | ac495af8b82bdec540ed7eb48345f8a89eb79ed459030d6c43ef3f6fc19e2976 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.12-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9477910bb0cbeb888194779387bc8b022f17a4650d11caa93e7a4626ffd31dd2 |
|
MD5 | 4bac589a76b2d765b818566615e8c2ec |
|
BLAKE2b-256 | 38c31ffa187d2e5dd75013b23d089ec03895bfb4b18d64b972693be89ba6a099 |