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.255.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f4cb0127e7b90eec6d8a138142f98cb1e7f04f5b26fa4435bac253913593129 |
|
MD5 | 2166b8c5cd975746c06eb8cdc0568b88 |
|
BLAKE2b-256 | 3b82dc0ecccc77a5be6086d637f7f04bdcf75e69f071ed0aa4c4d0ca65c1bafb |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.255-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 435d776d0011671b8e7503f2e91d78392a51b6df93c8aaaa40650a578cf78c96 |
|
MD5 | ee4c025cd9429e2d603e162640a03d35 |
|
BLAKE2b-256 | ae002601a0179709d8e9d2c5f4a7193f11ac8f7a61d4fb25cbcf4e7b73fa357c |