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.37.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e8188ef9d29084e32ba9fb333b6d7da58888c991788d4320f320894a56f320cf |
|
MD5 | 433f0216db0c9a65388b38b9168b5918 |
|
BLAKE2b-256 | 2a21b5715e46ed730f73c60036b0f81e62acab17dfcae3542fcd55e66a84e03d |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.37-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d06bbbfd0000db8296a2fb0833a06710f4cd95a092819f5fbd44c4c7fcf90e0d |
|
MD5 | 71356ce66771c8b12778fe473f41b62f |
|
BLAKE2b-256 | 4154d7afde72f59c970f089ee8959b60ac8872b03310e434429ee73da4476523 |