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.603.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 27a23da58388d37a98ae376687cd269331ac07bcf980ed82a98b479645cdf343 |
|
MD5 | fa80894282dc7e55c4bcdeb93ede42e8 |
|
BLAKE2b-256 | 60d5c36847a864a0126b95bdc828c25f04a29ec435bb03c1922dca74afbb34b8 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.603-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca6cc1755360605f8471893dfde73cb79f49cd07a789a7b1aa48d507169ce115 |
|
MD5 | f2844252fd8020ebe87b540b67becdbe |
|
BLAKE2b-256 | 03710491d2ec3f6d9954e4a5eed4d9eac1f948121205a3dca9bd2196e86a562e |