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.108.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c49fd93143e22a5093a873fe1fb66000c617bfcc2ee9583bbeace760efe5d06e |
|
MD5 | d76c303d38f6bd1ef475e11061343c94 |
|
BLAKE2b-256 | 921feb55eb374bafb15b6ca3d85dc85c35a6cd995c4e45937c8d72a81d5c66b8 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.108-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9810a1bbbb84cbf49cab579976c1ce4474c31a29ca4e04ec42469447c4c881cd |
|
MD5 | 6d84c14244f13fe7be69a858cd117346 |
|
BLAKE2b-256 | 05c45cbce2996420d900bc382cd80f208114d4507b007ff75f92e5efc5a84948 |