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.139.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 58d6fd311ba58129f68be8a11330b8ac53db218a0abee8d30f9ab26b58270125 |
|
MD5 | 3d463a3040f3513ae01ee039a89fb245 |
|
BLAKE2b-256 | 8f389fc27e4b98fa5f7db28aa9957d984490c9360fdc347a703e155a9f874c5a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.139-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 076ac09d1f99e643c54983e2eb8471257b8dc3ea76c6efbaa34cacbdcbad4a4b |
|
MD5 | f02bcc376b1b41cf6bc7d96979e2bea2 |
|
BLAKE2b-256 | 247007b7d2a56b6af504acfdf3c42a98dc963cec5a7fe87464ccd6ae22a8cbc2 |