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.911.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | eea42485e9b04f6fcdef6cec0e8853b80b4c822f50bae86f9c36e1a0a3e9d7e5 |
|
MD5 | 882b9701b248f6f971ef339182612b43 |
|
BLAKE2b-256 | e3876040c1615002eb12adbdc37f04a9a240674eb079557375a497bb1c6d8002 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.911-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 00421336c2e76ba9082cd073e8d83a59cfc897c1871d6c0561d9d6f842a5ef2d |
|
MD5 | c9a6e7e91963cba2eb1cc5ff2f536427 |
|
BLAKE2b-256 | d2a450ebf06c255cc982aebd39eef629bdc3c5ffd39c234e568392bd3b1b3924 |