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.273.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f81bbf302ad24e8798c09df3ce01b76a96074214fdc79b6a99ca44a66c3f5b15 |
|
MD5 | 486964342e496a57b0504d2ff3b0d867 |
|
BLAKE2b-256 | 2940325ea09aced48a9d932a4c92f24ce4e36d7a43981524febb8dee14d53f13 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.273-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84338f9bf5dcb6ec54ccfa950f62f9d6ac60e22f36f2a318e1de2d769100e187 |
|
MD5 | b8a0adfe21b3c2c4cb87e722228c6684 |
|
BLAKE2b-256 | 339ecf268d20f0bb5bce49d092d0afaf9f1a57a9be29e037221e24f21ce9b19c |