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.187.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 74a71bf1e75732a942295b3abfc1aa3d896ec7ca1d5787e605a40cb41dc02c60 |
|
MD5 | 193714d1670430f706f6405e5cdfc33b |
|
BLAKE2b-256 | 706c2710781ae9ed97117314666c5d544c7fd81ab362a5656b82433518632fa1 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.187-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d3a65cc5f7389cfeb6c4746e9bdbd8f2b2f6b504969a8c96608c16aa9674b245 |
|
MD5 | 9c1a9826f2570aba901d87290f06dcb7 |
|
BLAKE2b-256 | 29157a0f2ae268d5adcec5264d68876bc63b22adc298232186d7500c8f1d5755 |