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.18.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 29a4506d4eb4de40310ffe4760d0ca8b8e231da0ae0fe7be8d2d9fe898151f01 |
|
MD5 | cad0c62c6a7eb58a312ec746337481b0 |
|
BLAKE2b-256 | 420281449c3d581b6872246da98a81643b30bf447ddd1c7827efc9cd8c3ea4f6 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.18-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7a48d98958a052df27c6b08e8679d00323407bfdf4a78c389b3ffbddefa9c45f |
|
MD5 | 7c93f386ccbddee63bb470d6c0e6a28b |
|
BLAKE2b-256 | 5891eacfd8207ad143a217d905de4227b9ffbbc26e0ab277f9db6860880ab2ca |