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.908.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bad26849d182d16404838b55b6516bc07e0cbc53285066e15cc4f17d15a4bd1c |
|
MD5 | fe7d28ec68a4c60ae141e5ad03c615cb |
|
BLAKE2b-256 | 02cbecfc52f23cb84944f5fcc1051c57585d1dddd560ddad0032a2a4e97236a7 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.908-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3ed11ef9c5509799ba7e5c4a7ef5d1b9802194dd1c21744342a10a86a394bec0 |
|
MD5 | 8c1545192452a4dced59c85f734a6cca |
|
BLAKE2b-256 | b5f5f9e1455a5ba047e38c1f9cf6403a82f95525f2643b01bd1ecfe40a8e736d |