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.840.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb23a9c551d97381335181ef0a4bba0a6828e512b142849e3a539d3ea55063d6 |
|
MD5 | 58614c9b3e76d4e2714734a7438c4dcc |
|
BLAKE2b-256 | 419592e45277ede0d359487fed0c61d15e7aa2d6b9e5732f89ca2e624acab77f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.840-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee7ed79a168fb1e6d3ceadeadff1fd4f5ce3e274b56cc09503651537bb8c89f6 |
|
MD5 | 66ac2e31494bc4e7aee863af4faac8f9 |
|
BLAKE2b-256 | 6dbf09166bd3fa58cf0f06c2d654ca2d6e8caa6093a5b0b4761cc694a00977e4 |