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.794.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9557d75ccfca3127dcb0200ec9f11be4cf790e949daa9ab0c01a5d82bc65d025 |
|
MD5 | 2aaaa865b1bb93aa18b2fa5a1485b1d0 |
|
BLAKE2b-256 | d9ec6cf5f963ad109ddcc03d2540484ff3e70558e9e039c42451fc4838a83655 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.794-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 685c890c30184a2620456b4819d4c82499c5b00ce02029590b0ce3753ab955f9 |
|
MD5 | 4ce8f22c8e60d61b6c986eda563cdeae |
|
BLAKE2b-256 | d8562f263ba35509f3406f36a8c5e3524e63161fc7a74a30ad40107320290c40 |