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.847.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5860f88996a1126fef3f2fde53c8909187f0e186f716757e6be4df324a1d5747 |
|
MD5 | aae8c2a254d8ca88cb27464cca6685f8 |
|
BLAKE2b-256 | 2f0da5db78ecfe73fb2422decd4b3f47e5db454c0b835790e136afb8a07586f7 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.847-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dfae6ca96d61c22e1a7d0bc064449beadd1ff10ab6214174bf66a75a337e3bbb |
|
MD5 | b61960c7eb96e2165fea2064a26fac81 |
|
BLAKE2b-256 | 7a0b23773d4df1ce0a03d6715fd8617f215ac291c8a93c868548c7ce6fdf4fd7 |