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.244.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 594ab6c0d451f25ace28ca7f23f5465a1d43bf14d8cf5956801c33f32e930ac6 |
|
MD5 | b3021fb862149ec5595ce7f606a4d3e0 |
|
BLAKE2b-256 | 19242fc5be5fc0a74a82b498fed15d81cf81410cc1d03c8e0b9680e69cfc2f7d |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.244-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ebbae8bf6884672b77de8ed3c146a82e288c0f2dfc9d42f493ac2173a3951671 |
|
MD5 | c0104d636ed4068e4a23c8897ffb4753 |
|
BLAKE2b-256 | b5cccce2c51baf30577efe879fff53f9112eae9a07fdb63c9de00c4f1ef67d00 |