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.434.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c3573492d2df74aebdf962f6ccbbd8842a1bb6eadfa63f1002f685f02508e226 |
|
MD5 | 98a7de808662ac7a4ce2772c06da5b14 |
|
BLAKE2b-256 | a2456dfc37668490eca3df744012f7d85e8ad48fb4d3359072263cdd7427692c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.434-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6b79af4669ae0c66ac54f3a8b3431b455641fa3ada850109f9e0c64cc5931501 |
|
MD5 | 2e1a38d1efa4112a0b1dc557f3a88602 |
|
BLAKE2b-256 | 2d04b9a29eeb3622aae26e92c2d6ac01ed21cfc169096e9bfff2d5cca214cbdc |