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.154.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 609b21ca7b4c868cfaeea5047685a0d4ffec20b25497d7c5ba1222c03952c211 |
|
MD5 | ebf6a6ca93cee139feb35fa248953353 |
|
BLAKE2b-256 | be9bfb8ead4d0be47bafd33aeccd1188ca578cc1ce7644ffc92d41a264105d77 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.154-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d4c69abb8a1ea72f70c8ce74ef9dc1d1968343e8da917b686116b4476407b26 |
|
MD5 | 5e7a617c9aa39b17b83bdf7d21a5feb7 |
|
BLAKE2b-256 | a0a91ef58f5dd32714b49c525298ffa1bccd32b996143234434ab689c4f2649e |