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.905.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d5b0c07c8b16a8ee421cd766884efbaecd852f4545cdc1d73cc8ddee7a7e64ab |
|
MD5 | 6e6095d1202e5f394ccb2b73fb023a67 |
|
BLAKE2b-256 | f613d8e9ae19798c99dced87dad4afc2ddd9b07aedce457cf0325c206adab73f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.905-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 97f95541c98e71d8db1f49c6221cbe32dd905ace81b9c4eba2be8b2cc1785937 |
|
MD5 | 830fb69e99c1f1684179c5618476ee92 |
|
BLAKE2b-256 | b2d87b3b70c1726e30e262de60e545c31d1a233d254a7e3a8a0748e46c96b089 |