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.310.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d0baca2a18a90e064d9059bb7443dfab664f66606364b69e0c36e7dededdccaa |
|
MD5 | 82431ea3102295679ab9af244eb153a8 |
|
BLAKE2b-256 | 09569add911a3184ed57cf4e4ec8b8f5c63e52304b4abd91738ca940a27c00e3 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.310-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b0dbd7ccd8f37f8b125084c694f5d1ee0e439c67a8a41736e6d1a85b5c3d8178 |
|
MD5 | 5a5b65eff628ec0d901cd0e0e3d19def |
|
BLAKE2b-256 | 688f94895fa18bedd1ef57b9585cdc505fdf5a4af51d6a473a461086efb3b7a4 |