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.703.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1764a30fd9c57985c7b4507b287db474e676b38d60a4249d79556c2b27bdf001 |
|
MD5 | 698e9e866afe81fcbc5ff55e1199c458 |
|
BLAKE2b-256 | 179ab0ec894333ad9116dd8fbbcf43ffc8f25bb5dbbfc08fdde97c4011d53e70 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.703-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1bd4b2f790c8d12479de12c084c102d4b624b09a3ee494c7ba83d8eefb61778c |
|
MD5 | 163974c0f474cf1eab55fc3d54e79d48 |
|
BLAKE2b-256 | bee2eb333d8e20cc4fbc0a23d84317f9115dfdcb53f280cccd3106f6b95cb991 |