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.537.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c128dad191ee8a2d07f5e6fb5aa753cfab5bc7147950156776a9544980578c65 |
|
MD5 | 816aaafb44c203039f2d861f47761300 |
|
BLAKE2b-256 | dc69f93d2db096ee1acf5fc0855894f33d9b7ecf48509991fb487950b454e8a2 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.537-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd003bb74db6a464602490540fe2c828e0f005e7f3b9cc4a9c6f045eaeb60eca |
|
MD5 | d1e663ff08a52b8831e107a15f34fb63 |
|
BLAKE2b-256 | 388a238491eed5959c4a5c944530c423b53ce62f29afed676bb2401c651f688c |