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.584.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c3b3fcf55069c6c5d89c98f863521a76d9b5e83e70ff59154bd18a967973bed3 |
|
MD5 | 8ffdfbd066e267a96d7527f1a8912a37 |
|
BLAKE2b-256 | 5af4139bc5114f9a5cfd8ad9f39613282e8b098c5f317bfe356a90f61c745b58 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.584-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 28f56d88b69200f30c0b79cc64ffb9c77b7f7d49c74f712912b42d6458f331c4 |
|
MD5 | a75b22b49e9637ac5dec5ad2a0f579a7 |
|
BLAKE2b-256 | f508dc349ee88122e3d9fbc2ffd451f9ad30042061e2b589d872ee3f661696ff |