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.736.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 41fe127be03d39a8840d1fda8324d3ae798cedea9cbda1da7f4882de69000df9 |
|
MD5 | 29700851944a1cf11b16cfd97b6254f9 |
|
BLAKE2b-256 | e50b547d21d052757e98da37f99d492fa2e254d079232e4985b19bd911cd6f81 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.736-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a8f57a7afc4098d52de24d62061080d384d453991f51e49e160983067947fdc2 |
|
MD5 | 47bad787fd63fcabd18b24958b3c36b0 |
|
BLAKE2b-256 | c067d242ec0265ab51bc64dbfc4a221c41eef678ad036ca3471324e9ac329b6c |