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.321.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d2183edde60d2a4c7730769053c0da1d4781ffd785b05262555aa00cb14bf6d5 |
|
MD5 | a6eb99ad09da177e06abcefa34e63d32 |
|
BLAKE2b-256 | 43cbf11146c28a51c8bcff2aa3a5e7b78fedc6d0df66bdd3e158beb0fa46b02c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.321-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 35c5dc90bc6db27021f4ded58093fb864dd2e4ef8f49bb54f7a3629c29cabf29 |
|
MD5 | 63691f6025da09de93cda5890a722f58 |
|
BLAKE2b-256 | 55d00c634087e7346cb73ac0bf535a0c71a98beb886e8e9df09be9c6b86a4d84 |