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.686.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b5ae6ad740ea217e2f0019a7a204e8c43aed4f87b807f41812f31e63d52bf8f7 |
|
MD5 | 99ac45efc04083748fa277cdfe0a0f26 |
|
BLAKE2b-256 | b1cadcca09e78050661a78c5e12bb8558db6c176e2768dfa5eca17183e2ae718 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.686-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4d2e2ab4647d308ca1dd46e355612e61bdae9af9c1597a439c79bc7211f687b9 |
|
MD5 | 0ae784cfb6baf8084aca9d114429ea54 |
|
BLAKE2b-256 | 7bd9e4734dfd42c014de69ac5510265397c29ba518507b5242af11a5c442805c |