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.45.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 811dc9196d96dc74ca41794ff7d2e01421730cbd7eec52279ce97caab17661cb |
|
MD5 | 46b4b1ff3c437ec9037b588a5235b8f1 |
|
BLAKE2b-256 | c11779ad17f0fc9bebf918b1ece06d0fbf3c01b34bae3edbe898f9332c103155 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.45-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8dbfcf67265d0a04bf303f2dca0e9d12b39e6c9b9b2ecec148020b5b09c67805 |
|
MD5 | 2433d80bd1f72ed4acdb8fba7a4d0015 |
|
BLAKE2b-256 | c88c129fbd0cbec2c794d9445c736117000cbc78c8e1c3bc590d0b7d53cd26eb |