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.374.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f712f23856d781e66a2721f135d7898d9543e40014c6f08a87f43541bda2797c |
|
MD5 | 76337b02e915bd7e4743ea499c3d9bc7 |
|
BLAKE2b-256 | 135b82cab5cbab5b31ebe8aa6bf04592c3bb1e49ea3602a1cea389faf04003b0 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.374-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | edb654f7ab5f4570cf6c16efee3c7f798ed09300bb07ef3d49b63758b08a41e3 |
|
MD5 | 73c12fd35425d385b6c006d2b4a00b49 |
|
BLAKE2b-256 | f212573cc604dd318c5dfa5a96a364d1aefc2339a859c26c5536edfd0a921ac7 |