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.336.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 21bd76ad1380d873fd2b862323db591b008bf8b054249adbf4475ce14e240acf |
|
MD5 | aadb6dad50aa02c2f11128aabc57160f |
|
BLAKE2b-256 | 93c31f3e50abeda0864b71d3051890d789e15c7138be2fe044e13b0ce82edef4 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.336-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | df3bb04dc1953e2f78397c54b295dba47f15412693780abad76ffda6615c379a |
|
MD5 | 3b4adfc6871fabf63fe025d7f9d684c1 |
|
BLAKE2b-256 | b778bb176c853dceadd8f4d28fd8688fe2fe4ed277b3b14cd4172e702ab174ce |