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.745.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff45d816e47c48da7ac552655b1af51482da615c068b34c5650277d12735bf27 |
|
MD5 | 9d2ee13fe38343de0a39516291896d05 |
|
BLAKE2b-256 | 8b25cdb10a62adbd8ee35fcb85f75a79ca7b3f851e9f3dfd57aee472f9effa56 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.745-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5db317df6aa4205ca050737b40de8d8ac24bf22dfb648a6bfd323b1215283a43 |
|
MD5 | bd453a6dc6b2f9e6863bd7c3e413b261 |
|
BLAKE2b-256 | 447f13e50f201c6e560d84fa762fe05a89f7597393865be14c1201019f3d17d4 |