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.832.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d8df9870c99e1e2185c883ec4be30efd09bf309fe81975d38532274704f4133a |
|
MD5 | 9c1fc500dce9212ab74b61275eaad818 |
|
BLAKE2b-256 | 57a397e0e350749657a3bb8992969c4d52f3bd29192e07e84e2f1c55589e5a9a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.832-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7579a8dbba4d6ae778d4816600c9bb5518b2901907f5f01a60416d3710724729 |
|
MD5 | b51470d87b0a2c6ec194ae814e81bfce |
|
BLAKE2b-256 | 08399d8c9ca64e8d3858dfa04dbf37dcbf4e28c7d5a7a80f70738a00006364e5 |