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.889.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf648ffe7f91df7cb3e30d946fe717f31aef251a6839a1ab94dda782c7168ba4 |
|
MD5 | 8740982f27c2b19c95c5438293a55eb6 |
|
BLAKE2b-256 | e2b50cf8af2386c9b31121685611c7147cd75565c15f87993bcea737f921fa00 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.889-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | daed46132dad7f2427c07791584c8b64d157e67b0a85858f258ae7c2e73184c6 |
|
MD5 | 6a289f9867137ed563184674973a5eca |
|
BLAKE2b-256 | d5c536a41a1deb02f4511b7411f55254b1d67454d4ccaedbf1f6775c38882521 |