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.341.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b1ca8d855e233523224ed75c6b043875d780f53b5617e78176d04f8f5923524 |
|
MD5 | d7604b6f07438b6013ff25cc34be476b |
|
BLAKE2b-256 | a85baeb1bfde1a81116bee483e25f0df3803cb9122953641b07011a2cb1772ad |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.341-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9cee3cad06871d1b35dd6a793fdc37dcb0fef8288d5983546a752e80a8790c67 |
|
MD5 | 619ca2143fdb5f7636ad5bbf082b6a7e |
|
BLAKE2b-256 | c1b6fa3c8fc33e0c6322fef50e040b568cf7737c57d3c82cb0f2f626e5bc0b59 |