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.266.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 06c8d0d877478b21b4dabfc84c0289c69c9d6d4aa7052a93f29e7696de97433d |
|
MD5 | 13089c2b1af61e26050a68d550b9d457 |
|
BLAKE2b-256 | 8cd5545ee8a579e8d0c4dff781c9dedadfe103b2f5624d1b2d679f243f847c67 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.266-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | de45519d362f394d6aea1aebeed062b300bd351a6fa16768f01e42f4b4199020 |
|
MD5 | f48f464a6100756d72439a7d21833ee8 |
|
BLAKE2b-256 | 3bb42ddf1e2e904ae0c27477726b9ced7413404b83c13336f9b9d3d5258dd42a |