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.448.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e301b1022b90f998d8cc52cef6f7f5d0a5331277b46210f82a4ba702f639e3e |
|
MD5 | c90f60a5e9f1e3b36540c88c67e687a7 |
|
BLAKE2b-256 | 7ae9642cb5b7de39744b230add3420174b671c20483108b975cefff8aab26550 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.448-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3518f7cc8d08d52094332a6652fa4acd726f013bd382294386658c86138e7b17 |
|
MD5 | 9bbc74dc824ca60fbfe3e2a4fedf8119 |
|
BLAKE2b-256 | 02379e1e17d69933d7994105c6f8bc0fb26822938bb36285fea93a2d83d25211 |