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.784.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ddeee53e0c7b02ce2b7b3ba92a1635efc7d16e37ef06e33edb15a3f6cd7501ab |
|
MD5 | defae702316c3a520c73f735d2cca8cc |
|
BLAKE2b-256 | 6852ab6151d03de5effaf20abc5acc13003ed5416703dff0ce0ffc862a3073f3 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.784-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9716d26812288b743d2bf2a57e74a05d97507e9ca90034c2f093a381f7b9159e |
|
MD5 | 69bb600ed9b7ad83025497d93fbc709b |
|
BLAKE2b-256 | 324350f465d39155ab4e33ce01144ebfeb7569cabff57194781b7510e594533b |