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.566.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e910707489b9e4add433c20ac05d982588ee7ffec475343781a7ef8e568de948 |
|
MD5 | 1c701088a12376db74d9d93b2a93fa0f |
|
BLAKE2b-256 | 14b77c73f45c8938f0feb2108c20f9c44348f7ad37632bd044de4dc7d394da42 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.566-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 65db04126d122c0cb543e05a1a809f5dc5ffd432f073b92c14cd6e5ab31393fe |
|
MD5 | bb030e71e98e4109579c50acf4b69424 |
|
BLAKE2b-256 | 029aa60da1486cbe2fe121f430c60400cc7fd26b8f92d9ad891085954ff48a54 |