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.173.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d6afc6aeed03821c5e5f27ece389bd5c8934b00aa52dbc2549c1f98a9d23bc9 |
|
MD5 | 5cb432be9c239db053056471101bd5fd |
|
BLAKE2b-256 | 63063a2133ff999fa1688b0e935d57320adefe369b28c9f56464ffdf0d3b77d0 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.173-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f132027b14307478c56af1c6f774eb5fccab3aa658ffab5b442bd72f5875a06 |
|
MD5 | 342670669b5d6bd1d6e610ad2f61c78e |
|
BLAKE2b-256 | 99486f9fe40d71e5e3c8d2660e7d5629c2a669d88137cc94cd8c649362000779 |