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.364.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 44e02f7664b74133b5e0b993ff99c622e62b2f83299f21b0dcf07fc79bd4c87c |
|
MD5 | 4baa38b1fb978cd289bfdc04f4060c40 |
|
BLAKE2b-256 | 465331f8dd718c97aabe14bf826003b55382a6741deedae576c7d5d59996f49b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.364-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e44c7eba214fb20bb8c1fc70344c05883eafcac4874dfbedd9b0cf4f77261f0d |
|
MD5 | 70636301960131dd76c87b3a42312eac |
|
BLAKE2b-256 | 24feb7efda2aa909273f91dbbad43135a3b03ad3786547d2bddb2df9a38c23cb |