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.541.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 98f1db7ce053928f166190e1f64dfce09b0c0d7481d281a6458f8343d549f884 |
|
MD5 | 815d6ad2245efefe9630c630b49b65e5 |
|
BLAKE2b-256 | 98fb1d2feaffc5338db2b5889bbbb286c0af61b4538d6d336e770c9091835a6d |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.541-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 01e2d55205edc936020753d2f56825e2b11f03e72ab9988a0bfbf7faa7cd9562 |
|
MD5 | a5de18a19f6a39905d119d3e4b8be8aa |
|
BLAKE2b-256 | 95d6344f12419470ef92afe0369e9fd164a906aee1a425963162211b3e346303 |