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.373.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5dc9f7702e7d76d905857b514df4104021562b9bccc22bd8c19220af1860cd53 |
|
MD5 | d21763799d1d72c03c15ad521481bce7 |
|
BLAKE2b-256 | 4f073ecbb2427f745e4e7e6771692611865d7677e18f6b4ff4561b48bfe71f86 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.373-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1287960fe31ab0d8857c7ba32092d5dd223922273e968f68b64ef72493d7e021 |
|
MD5 | aff6cb65257dc3beca43df400d69e79a |
|
BLAKE2b-256 | 7dab45c868b4f071c49ba92274d3fed9dd81dd9a149ce3c2ffc0dd0c901476ed |