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.664.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2f240de44db4bf6661b8d306d9fdc0e97824527805991ddd603084d5dca90bd |
|
MD5 | 278b436d6cb8879638025fcdd809de7b |
|
BLAKE2b-256 | a1c737dce60cacd41ceb2e5abcd8a075d51870ea56b9b3fccec3536c2e64d006 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.664-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b93788fa5962b876297740edd6339e7f9f039ce12322ae62fe03de10501a960 |
|
MD5 | 22eef669633fe450f369ef2555a32179 |
|
BLAKE2b-256 | 4e252dd3210e2b48f457e002967aa6f0649f0c21608421a0f353835039242503 |