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.179.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 772f9958a14fd6f41bd7029810ac301a542adf185863efb8ebdd6b84a87c7b05 |
|
MD5 | 39f0c9d177bf233801acc4dab0d7e87f |
|
BLAKE2b-256 | 11069f315f07a260dc24e135d0f5c970894558782ab1b5a3f61f26e4406022f9 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.179-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf28956603941ddd58bb6f2bfef673180c5f398197857da687ecf9e278601e25 |
|
MD5 | 68994598885fdb6d7f47eef52b6dff52 |
|
BLAKE2b-256 | b8aa03955e01c23287bb898fd004cc01d8b31fb326a3358fa35b998d6dd7973a |