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.256.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7323d65532597589b1b7873328b829c85a668e255e145f31cbbc22fededa2be9 |
|
MD5 | d91c2b98476ed3949852696bb10490a5 |
|
BLAKE2b-256 | aadf820906704a7bacc9460e1263cd48d610fdbab56a33f2e3624c3a99038d91 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.256-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 02eb1074e1f349e4d1eecd857da00a892f37dbd9bad17aad3f659643cfeabdbe |
|
MD5 | 601519d21bb3998d9e5b7d38766bb299 |
|
BLAKE2b-256 | cdda6584c75afb097875f9b507361e0c7e0445890cfd76392122f4fe926ad36d |