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.194.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 27aa06554e50bf0c1b672677158b4ab97d5da529117a07aaa339c195d0067493 |
|
MD5 | 38463365b114b444d79c7dddd5b545b7 |
|
BLAKE2b-256 | 81b550448b0b0926c5719ea979e5359c4306e2b269b5a2c428894c3af984c752 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.194-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc6b8ba54dc2efba375e5f569b42068d029ae1aea08516aac04f2f97eeeef42d |
|
MD5 | 1f1d040050701a12fdbf4cb8e8794ebc |
|
BLAKE2b-256 | 3f610bb0500ceff5ff856a8f6874bff7a96ceae81cdce45222aa1606d47a9b46 |