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.96.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f205ef46ff95fbbd267d3d8f3393ad38680a7bfa0741d2f573568a8b4167bb02 |
|
MD5 | 79f4542ffbe35afc37cb9ee02620da39 |
|
BLAKE2b-256 | f5b60e5affcf0acbd4c534027db360a71fa8a8ef4b2a5479731b3a39e2291f0b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.96-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c890a13a7448baf9b3e8ea0e65bfbea07b8ac93c43e45ee3534e3bc828b501b7 |
|
MD5 | 075b771a0509d15b86e2b1a9c0fb5b98 |
|
BLAKE2b-256 | 0536498847478a22f713943c39272d788ff4cb947ae4c74e0ca23961502070c5 |