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.16.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e6f98ad1d2312303f831df3afa2d7b83f9da5e5bc67501c3c51ffdc38902676 |
|
MD5 | db162fd2c9cde0c32b8f2ecce24a93d3 |
|
BLAKE2b-256 | 443a43e6620bf404eccadc74eb6b569ee47a485dfbbb5ebb3e71d371c0684bde |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.16-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84cb85419e1a37de00952bbeca450bf9df24c7758fe5c515a5e0a75824c0626e |
|
MD5 | b0262319b048ae8a59818e48d48d8521 |
|
BLAKE2b-256 | efbe520d208b296900b52dceec1e676721cec5f815c8d02215176d59b8dc2028 |