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.874.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 82db2f7d2821c406541bb19cbeb1ec69b0cf146d45fabb56dfdc6a795ffd5b3f |
|
MD5 | d579b29df77451eecf86b7c9ffe186c3 |
|
BLAKE2b-256 | c2cea490f8f56add034c5b05dc3207c514ba0991fcc77a6e886282da6083309b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.874-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 968b9fba25ab1ddc75c782ee8e4cc36c952b24b67d009907b5652dc20a69ea44 |
|
MD5 | b3c68e8c2378d60f1a678cad6d9febbd |
|
BLAKE2b-256 | a99000b33885499e39a3d04dc37288d2b03b6ee4d69ef31dcb2e11e08112119f |