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.636.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63a9c774bcfb4eec42d18fe006afb0779e03b9d144706728ed29e4381c9a9929 |
|
MD5 | 4467f8583cc4e85babc850975ffbc30e |
|
BLAKE2b-256 | 29feef83597badbf5430ae6888b7e2ebf4b5e20fd1adda33d8dceae7e42075c4 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.636-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 65794fbda05dbc212fe2634d235f35413149d878867603a514d341077cbe02ef |
|
MD5 | 500075192c6a65af625ea1608a5a38b9 |
|
BLAKE2b-256 | 1fd88b0a18fa969ee1c6ad00a55355e384fdc0a9e9f99657b8bd2705ee294c40 |