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.430.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 884f3aed1947188f5994fce9bea1a0f97ba923031b5d5e8cf487e0307f0b646a |
|
MD5 | e1147f40f465f652a38fde26abec05d1 |
|
BLAKE2b-256 | f1e3ba908b5ff8f110aadd301f683e0afbb98a3a867a22608508e9664943985a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.430-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 27301bb828420eb991b0630ccd730de553b2553787f13a9c408231cece948e6e |
|
MD5 | 3393258e6d13f91763fb6fa3e9ca2582 |
|
BLAKE2b-256 | 874ff29d145051a2ba7f797585904e4a4c1021439e92d0fc74f4de7b6b313a27 |