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.99.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b404eed8c576732bac1aa6fe59cb45ed70aef6563004ddd37c5915784df9271 |
|
MD5 | d5992fdb6037f15f4f65af833f76b6af |
|
BLAKE2b-256 | c7460f42bc025c61bcf7528be4662164372850647ddcc00ec2a211a0b9e071cc |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.99-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 51912241bf99ee010d7a1b1d5aef311b154d3f976711064c77bb227cfa375438 |
|
MD5 | 686b5bfd03f32a5294bddfec02ae65e4 |
|
BLAKE2b-256 | 075c6e9b11902eefd8b542774f7725e8824e41111d815c26b10b51f1233a4322 |