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.467.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e32ff7844f62930ca1ba2f92d9eafbc6c353ae1e2a6b885fa703e308627fb020 |
|
MD5 | ff8bc1b48bab63dc953595c186a5bb5c |
|
BLAKE2b-256 | 12b37819200b75d1c2a293f910192ab907132e29a810917c848b24d80f92e699 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.467-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 793b1fe969e176feb46f1d40dc87ad841d06103f27fac93797e7633a566fbe02 |
|
MD5 | 46383e05f7c53e0fe26c3f790e6e4cf6 |
|
BLAKE2b-256 | 6d8ff1502418dfb6cdddaf5bbcd0340e1c9c1a4bb2bbc488f39eb8031f1055cc |