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.688.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7a712e45672ddc757d3f62a3876fc7cc5088060ce23a670482d87448f81ec252 |
|
MD5 | d97845c195be4fac3b70ec35e63bec24 |
|
BLAKE2b-256 | 186db43c7d0d0e0df90d43ca8cf887264526c5fb08648987c089139960f720b2 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.688-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | afcc18f41b33fe8fe40cb81e0895525287eb9daf7016393d22d527191bb83493 |
|
MD5 | 4600bbf8cb9e3f0727fa2e7b83013c35 |
|
BLAKE2b-256 | 7550ab2187ebf31167e068b40a6cfabbe22975d6e8467c0d9a615256904c4f64 |