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.725.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6799919b243dd0d29ed74038ff8bcfb140cdfcf21e1184d52421d904a55ba235 |
|
MD5 | 6c99bb6aa8185e20842602834c724465 |
|
BLAKE2b-256 | ed9cdec668e05925ac7f1be52ae235f330342c6edd8b298ea31752e4276c2d46 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.725-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dae9d38b69b7903f5d13c7b762071fce41adf41df76fa59277a1f82b31a339ef |
|
MD5 | 529a9c8baa0a8d37ea7d8fc58d96be0b |
|
BLAKE2b-256 | 2d28c45c39ebff114a7d546f3d485ab28a31ccdb33f4876d446fdf8e858a18e9 |