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.417.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a63e96707d1b976098c2a18a2d67bc7071fbc0ae54a748a0d8a28dd448240ce |
|
MD5 | 32fa94778f4eabe838dec8aa9344cff2 |
|
BLAKE2b-256 | a4fb78d64511096817e7616f2d769f6f17459ddef2bbb4cb2b911bebbf255823 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.417-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e9f3feb1d73d8df8fee81ac8f965534f655efe1eb6fd3f6284e275cff699a423 |
|
MD5 | 6635583e1ac0472695f5dc45c9ceeea3 |
|
BLAKE2b-256 | 0423c1f254e31f3ecffb0d57950f1ed00d2df1560ec17f7b760b3be81573a88a |