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.524.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2ea01d304d1b1435ad67be7f29bf265dddf4b41ea2952c2d42836a5f06fee86f |
|
MD5 | 559533473b896fb051e12325b75b355b |
|
BLAKE2b-256 | a6cb1c574b5d76451954f35de569114ef574bf2b024e48f21d72cd2a11c49bb9 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.524-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 98b386e72ce0d68f6b06408738553e7787604131526bd0d60dbf91efaa4cb35e |
|
MD5 | 2ebd02edcef5902e5491de117bd7f8f3 |
|
BLAKE2b-256 | 0c413d0cd67e1be8b656af34bf05ef2a08dacc0a2bb2eb6c233cd1c00d26cec8 |