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.576.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 277e0ac96cb5878b86d9fd0951b01641fb4d04474fda104936a105b6ecfe9f75 |
|
MD5 | 2020c12fca8eafe538fdc8b047711664 |
|
BLAKE2b-256 | ca2c6055504ded705cdc5b834506f1cfeaa54acb365eb95232947c50dcbc36fa |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.576-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 951731c06ff9ef75dd5725bcdf3b6147d60d87a6725387290c6ff6f29b79122f |
|
MD5 | 81f406534a1089739896fdbf7ca3ada6 |
|
BLAKE2b-256 | 584b829dcbd943b729739a5b3c49c2e57961e7a1be00688b1cc66b33f7824c82 |