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.444.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3c743ce37c190a5c2f4d0ffd779f2c60b08c0d5f030063f678ea5b3d86546612 |
|
MD5 | 1b1a2c293b27027c07f6d7a1820fee6a |
|
BLAKE2b-256 | b5a7a9880a1681722c2d13fc500b6e086596366b1dbbd186dec6c749cd5888c3 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.444-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 97f9232f2dbbd86dd966fd3d6d2ebd379266315eba997648b6b667894f0a2426 |
|
MD5 | 17054db1739a44ce551175f112d95c94 |
|
BLAKE2b-256 | 1dae622e3237b04a0c12f2447c0df7a04cfee73059272297986aa9807e2d1216 |