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.360.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed5f08791dbb515bb1a758eb7a269fba277f89b05b190d17835acbd3758bfbf9 |
|
MD5 | af21b3a7c8706e3a76c03d81826b81aa |
|
BLAKE2b-256 | 4d32e70c21ad51c236bc60ea6fa26c68f1009df8babdcbcb171ccaf645286b52 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.360-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f4ae8055f5c54ef13a034b4aae9b2a42e21123ca3438acef54ba1bd7adce370d |
|
MD5 | 498aaccbaaabfd473b9e122556fcb5f0 |
|
BLAKE2b-256 | 8fb96972348d63bd62d643437dd31027cc4e75c76883c49252ecc6b81fcea11f |