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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2066182ff2f565465feeba343345ab2e927484c51e036e84f06187edf54b7e2e |
|
MD5 | 91ffee4260d36d62fe67f386f8967ba1 |
|
BLAKE2b-256 | f0b45c38810c0100e8a7bee81d791bdc2b607ede5c79165b41747cc663a5b38c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ce8e9655e8de0870d516d3178d27097b70de83316a9d21dc2e54f739c866147d |
|
MD5 | c4db0591fa31e427fcb9de6402e4e32c |
|
BLAKE2b-256 | 67b9fc1ec3a57386c05c5e2f9513335e6cce378dea2906744c7e8c3eb726de7e |