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.161.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f55012773077e5da25074368e44a3a17c913e85c88627e8ba469301c89b678b |
|
MD5 | c0f9f359761fb3e0ce39653be1a16c13 |
|
BLAKE2b-256 | 62d8bfecbb62bf8aa9891b9aeedca7f5b70355de2eaafdc1936da7e2167e5912 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.161-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b9a03a1150d7bf63b1c5141a8777e3e06f4452c9442f2ca12ca2cf95ae43dffd |
|
MD5 | 177a41ea281361379c73c090db568604 |
|
BLAKE2b-256 | 8ed51193d2eec76f2e3a48145a98b38626e8ee65f152a3374f826c33be83b85b |