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.151.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 319a22edc4f1f735a89e1e133da0de53369cdaaf15ae5b4fd7f9808df941ce20 |
|
MD5 | 9b97e4b683d406eadf82052cc698654c |
|
BLAKE2b-256 | fbf64712eb08213f1b2474f29851d9815fe78d5ee5bfe6833b82054222de2a6e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.151-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 795278a031e5e6cdd6323fadfdac244c103168deb05f5b5eed442086a1ccee33 |
|
MD5 | 19c48b58c8542285086fe193fd3ac70b |
|
BLAKE2b-256 | a0a23258af762b6d0802e4ea47312305bd44e30f57af5ab2cc1cee9dab9b9ef1 |