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.696.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca5f2fb0535d374e0c3754fcb5e2ff3b2cbb67329bcacd736566f87dc86a4b20 |
|
MD5 | 0899b5477ed6229e70f7065c4eab0a42 |
|
BLAKE2b-256 | 7fdcefd9ebf860ccd59e07509187d0626b9fde96f41fa1c56228b56ceb5b7819 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.696-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 085437ea5c3a2a0c31028410de432f6976b6a930274b04781f0f61cfafbc5775 |
|
MD5 | 3c0d65d08516b8c3c0a2960c3029ec5c |
|
BLAKE2b-256 | bcd66693f809fe89c20bc448e37460255ebdb19c0d3149942b54ab3176ccbfe3 |