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.398.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9ef687bf6da7bec5e9d7f00bb97fae0f9945ef4dd163cd5835cea60c9e632107 |
|
MD5 | 8681a0cfd62d3fc3c811de7b996ab7d6 |
|
BLAKE2b-256 | 4a70f8aeec22db878393e6b4be9a6f17c98ad7ddeab54532e810980615eea9b6 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.398-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6d8b96c0ea8d0fbb18c92d961e49e03b2e1f5bc7ce413a82c13b136f7960350b |
|
MD5 | 110ffb844ea4af99b6efa61b9baa7975 |
|
BLAKE2b-256 | eda9c52ab4163cb7190e820da9e3c6c8ef245e0ca4f0b1184bd1733561486eeb |