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.823.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f3d9e87cd683008f659576771e411a8af53cc17727ed851966061d3df07fac56 |
|
MD5 | b747994bf6f77ba84b1fe39e6939068d |
|
BLAKE2b-256 | 2f14712bf3a9bb78d21a5497f78265fca5db258d5433254887748de4cb662bac |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.823-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea812526b75a29272acdb282cfe332558f0dd9d873197ed281463bf31e452e26 |
|
MD5 | ee4321338b109bb656769d34ca256e43 |
|
BLAKE2b-256 | 97936485f770472e8e0798d4647efafcf89af069d0760b6335dc046014a8ea76 |