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.93.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d1809f919cd2c4f59deb84d79edef919b7a479f46b77289eb85e6b01e784daaf |
|
MD5 | c06f85bcd15ee1b368d94bc8238a3d0d |
|
BLAKE2b-256 | a5c9bfe549e22492efef7a50210e6dafbdb9b4f861b83c97e478e076a7b0190c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.93-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4420c43dfbd8861989ac743f5dc187c7c6be195284828a5b9acba2bc7ff072c8 |
|
MD5 | c65c5e834fdeb4613e19ed69cfdb6628 |
|
BLAKE2b-256 | 52af3c53502e20c393df597d1b8e17afe3d57d9cd7e833fd94e4dd3cac05f020 |