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.593.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 202e5d52e05c8d0d9a9947a46a9162eb401847163b79b659d3a731107a78bd93 |
|
MD5 | 4b90f45114b910506ca2a1139992df2e |
|
BLAKE2b-256 | dfa28df348520201e0dd6605d1913ad6f53fde9969b8587d1733701af12eed4e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.593-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3afeb4fd5ae252af007d57e01cf47ca47d85104ace67b0f2107a7d0f28105be2 |
|
MD5 | aeb72c305d471f0eeb889165c83fe153 |
|
BLAKE2b-256 | fe51938a9bb4ca79205bd7f4b7e9bd3e34730782f907e364826ada5525e348f9 |