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.36.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3ed202610387b5377b6cb56331fe1d60896cba37d8d1f99b2916fa8f7c323208 |
|
MD5 | ef916af8cc199318cbae5e6aa07f5578 |
|
BLAKE2b-256 | 032187c158a3476b4264c2c87ed6e486b8e9ae91a96df9f08d07c88b141f66c5 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.36-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b78226bfdf0fa44916f08f9f708cfcf1ed3198dd87f26a6d35f753d28a525087 |
|
MD5 | 2eaf0c19a3de39ce662b1498dc9c8fe6 |
|
BLAKE2b-256 | 426d9f97e4cde6f9867ca40da2181579e058b6d4465105ba9d31558c0fcd5cf1 |