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.887.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6680a6afc1cc11db936a0c11019c6eac96c6d8fadd2ddd9745a3e8b9e2162fa4 |
|
MD5 | 4e6a4cfda7c07fefcdcb414fda1c102b |
|
BLAKE2b-256 | 7cc8e25106bb004c6840684758fb037bf6e12d1f10abf979428c6c45fe2d36c2 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.887-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e550e5fdfdac1b2c7e7d72ad34e49db870944cca166770bab84a8dbdc80a11e5 |
|
MD5 | 7d0d695df878c20c84853c7140b8e46a |
|
BLAKE2b-256 | 27c53b903e5a4ee3fdb9fdea159948c2c3da16b35a1b0891f8e31a5631aa5aea |