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.733.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4500173ce37b4eaab77ee57868406a2af080ff06335e9bf5aabbb8bb2a052d19 |
|
MD5 | ed09909e5f8cde3495a0eecd2c168eea |
|
BLAKE2b-256 | 91f02b6474df15c740e3b161c9e51218cbd7efc8cb64b9927d3916c25000921e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.733-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b950b52c7b322c2835b6df0733140f69dba41bbd7973625efe56264fb2de3bf |
|
MD5 | 665e76c4a5539069513bbd94445bf444 |
|
BLAKE2b-256 | 793939862267cb6f424bb0bd3a6e7a148ab9cd336eada12f627e6395d7c63889 |