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.141.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1a6ad51cf4a15dd7a46e00ab5deffb8cf55c1552affd7f4176f81fb964e600f6 |
|
MD5 | 3b1d78268103628ef69960b6a964f07a |
|
BLAKE2b-256 | 892e1afa118cf9be3337eaefd8866c30fe202721940246701fb9f8dcb2795680 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.141-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5757f2b14c404220e71f5833005ac4b48fc99348672c4babc02e9c36c894ed77 |
|
MD5 | 968d8483d1e45fbf27be9e64d3c80422 |
|
BLAKE2b-256 | 1e061b7cf04eaf329bdd6659a830295e45b7e82c43e5430a078d0d160e4e2720 |