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.38.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 217fb5d7bcb5efb90dfa6b1e3a23c4e67690f92d51fbeea2c58f1bc5c51fdac9 |
|
MD5 | bbbea4860712a1a8e9c5e5d69abd6107 |
|
BLAKE2b-256 | e38ede926c6ae21df2db7f4b1fb5f4fe9bf6cbf0c601b03fd5cd67a357eb6848 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.38-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a3cafaf2f13c16d21950df6969429db459ea66db09ed0439f764d901b68866df |
|
MD5 | 6f4568eca57c41052b65f170a9bc078d |
|
BLAKE2b-256 | af43015ab002d12c81cfd2b891d89a31bb660f6e79abcef23747e3e34110d1bd |