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.596.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 271b21ae03e325f52e287ccb410227ce146bf8f17e28c3e72d3d99bdf226c1d5 |
|
MD5 | 64b712d96ada7ff856be941d49d4db89 |
|
BLAKE2b-256 | ea03c90dde60617a990ffb11559e426cf7ae279673ee881e208ed81eb246f38a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.596-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a6e87a7b36f0830a4998b83a29a897f8979149af04a91999144140faba58b697 |
|
MD5 | 3607bcc95c941f3ae7353948da29f592 |
|
BLAKE2b-256 | 2b7eda87f21e1524bae5fb0727bbade80bd61d606a7cb2921922be849f495443 |