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.888.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63b0d8e349195ea46340c9229caba1017e9c8586f1b4c57de5c41445f662be0b |
|
MD5 | 05b90705bb54ac64feb9ebce71f7dc02 |
|
BLAKE2b-256 | dfb83e2c54b54d03fce968ab21a11c58c64dc60017f574b5f8d0e0462fa2d75f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.888-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 12b58a7432db96469c615a2c79a5f0759e733e6e4d9d4378076bbf4c7aeda095 |
|
MD5 | 8d136086cdd39dd8d832469e90d21cc0 |
|
BLAKE2b-256 | c0fef8cf7cab3b1986e63ffec3cfaea4f7f2bdb157c81c0f276807b4005c820e |