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.777.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6a4723829b0b04eda675555eba91774ea9a81e3e917ce59118b77c446abb2771 |
|
MD5 | b9840aceadc8d5e5d451f5fb61ca0aee |
|
BLAKE2b-256 | ca376b96766850ac732ca28277bb27a1acdb430cef376ac6d5477b16bcabace2 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.777-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b64ee9d7978f89743c81f06643db20cab0732bc997b2c7b4beaebea1d1c594ef |
|
MD5 | ad1cbd63e002de7ebaf10fbc0056f74a |
|
BLAKE2b-256 | 1388d86e64589e722f31440e58e8f0cd139b4f0e01c73a5d55fa16c845de2065 |