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.885.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ef77d8eec740162701eb102f6020fde4585cb681770913911e94af62a3d1651 |
|
MD5 | 41ecd3d85a1d9f4334ce651a8d06021d |
|
BLAKE2b-256 | f46c9efad021deae1d839fd5cffa45b15afc44de2c37ad09137544375537fb24 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.885-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 335c575b84519a7df1292d83097ba07aa774adf48641144d0136a5688fdc7251 |
|
MD5 | e9875c65972c5f107bd6e81ddc5d2b32 |
|
BLAKE2b-256 | cbaaf7eb9e588ed11383f160eeafe205f3e573bcb0bdf0a2312d18244061136d |