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.120.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7dd972fc5f4b7430042e49c5eccccf9dae2d0fa98ea24dbba22b1a2c5fefd6c9 |
|
MD5 | 75426e16b20f71d2517cc40ff9e30000 |
|
BLAKE2b-256 | 1adc177a29707227d3259b2b3d0294c443847840bef5de418854c3dfc92aeffc |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.120-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 44baafecab14872ce9c68b2cb26435159780cbdde6d6ed695f03c14d1c3e071b |
|
MD5 | e79ca946f5451696281f299fe57409b7 |
|
BLAKE2b-256 | c833a6db56d420cfe34150305b8ff5cb659e3690d448eae913e12b5792bbd1f6 |