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.914.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a74300d448b99cb694f63b7516324c33bccac994a27be7ffa295c14ff67a254d |
|
MD5 | 02ad57c81970165ed74acf22de150dd2 |
|
BLAKE2b-256 | 44f001f366591d092ed6bd6e94393fef228581b9e9c04209d90355b536840716 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.914-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c1f8fe8ec8514b2ecb18644a18b288619147c6b78ce594d0ca747e47b53717d |
|
MD5 | 6fb0c140b074f8e6757e5edd20a4165f |
|
BLAKE2b-256 | 41d666508fa6c7b843f28b6a90c2134e445417ff7f5b9014e23fdc4914b687ba |