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.466.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc032bbc3bd9d6736544e8c6f29063593b5373394ac90f8b03731b4574656c39 |
|
MD5 | 4f07a126a379b41d7d1ca0ac80f2ce83 |
|
BLAKE2b-256 | 0d5a0d78ed8bba0ba8cc4eeba14820026103971202614def0df5c6b4f43d1c29 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.466-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b6a895aecbe77d4c468bf3ccea812cf7fcc619a88b389e2314b58df97904f6d8 |
|
MD5 | d2fab1be36aedc5ef5cc691a611ec6a1 |
|
BLAKE2b-256 | c3603baf1d8e2ffbf6456f605785765d965977faa913c861bd37a10ad5771214 |