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.543.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3338798469e8ccc068f9979263ce08ae6b1f729bae7f034fb88c4784e1a0142c |
|
MD5 | f1f74e34a191c3f02455b2a5f3fc2757 |
|
BLAKE2b-256 | c9865561eeb7f3eb1a920287da69f1fec00876c361f309683a77c7796c9335ce |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.543-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f3941ec97c3e8488959427c3c5bfd2d26d9bdbd9054bcb38f10787d02e863b3 |
|
MD5 | a8e068ac699be3427b395c4b7d2b62d7 |
|
BLAKE2b-256 | 10182941dc68dcc32b77c4d6fdc642cd23a080263731420a09cffb6c3529b4ea |