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.308.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e0b4437296ccbdf5067963cc752289ca00633a4ff98340102d42f7a05411cce5 |
|
MD5 | f1759494326f4bb125dced0c3c28ccef |
|
BLAKE2b-256 | 38b1b682842783bec835212ad9f5c499751bb762ec47f3d16d7c36ce09bc3f4a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.308-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ed7ae939658a18802c6ae96d598a597d24d57f05854f1f4f0484213aaf09ad7 |
|
MD5 | 38007e10581024e217ac583703f57c7c |
|
BLAKE2b-256 | 575c57481a442738dae0772d0ad286adc216f89ffe5b77135c35a9a014fc6556 |