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.369.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 96ada5fcc6d9f758af41219fab551dec18db9d29bac88d9f51410c8296d9ce28 |
|
MD5 | afee9270f3b929e53f2d5a1b8c21d55e |
|
BLAKE2b-256 | 3eaaa34fb86118e1868038755895bf5c8cc52be4bd0a036b76a10f3d942159b2 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.369-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b8e27ab6ee513a0eaedf6652fe9f4863cdd81abdcffd0e15639c91d549b01bd |
|
MD5 | 509fbf5a911091ecc2545857b367a449 |
|
BLAKE2b-256 | 3cab08241124f120dec989dee907789ded274169ace2372d35390eda5e1e5472 |