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.301.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 74b891c71d19e8d098e707ca4a82e484d88d6694bff26a0105c0d397f6fcfa03 |
|
MD5 | ff2d0c558d9857c0162cdb1a13507cfe |
|
BLAKE2b-256 | 37c1a1884e6672b30bd81467b208a08d43c3fdff3c69b151b7a7996213791f0c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.301-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e914716ef0e07b4008f368fb2bed48e17c1fd7cae5a17d7e0a575fee42c8b764 |
|
MD5 | d9dc988068eddd9fa9a0afee3206c5d6 |
|
BLAKE2b-256 | 608e32e47fefc0bc36be005229595de90cd450b38a2e498b6b10ef01b09e1401 |