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.361.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f844fea9a9fab7fcc16c2297f0f77b606332b6a3ddb96ca3368229a0c7af734 |
|
MD5 | 6b406aa761be9355b01fe28582864e76 |
|
BLAKE2b-256 | e4481986789fc07325a656722514046fe2206ce6c6cad5aa37e7840f80ef629c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.361-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5a4dc76fef68e64a85bfba1184b3402ff8c326ea8e209744e7ef8766453b5ef |
|
MD5 | 32cd38cd14d741cd70ab6fe991ffd39c |
|
BLAKE2b-256 | b557a206055c22600fdeca41c5ee7be73f19d0d2e6e428c382467ff20e17a18d |