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.546.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 30afe1ec3ab29bf1cfa8306114fc1f9fb6b13b61912d42d289d380afd9b29028 |
|
MD5 | 253f92dcd000b19b055bf97dfa3c8590 |
|
BLAKE2b-256 | 1c36ca670713cad0c9e8ebfa60f224eca7ab5fae59015d92e95c7df9c0584bb5 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.546-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fd6bd3e6e92cabdb6a507a1f29b8efd58fd47b2a9ebf580d9789c9e14fd090c7 |
|
MD5 | efaea9080fb437b8252661f341d73f8d |
|
BLAKE2b-256 | 583d833814974a38362d52059888169d870b11c1f135bdadccdee4c31002838c |