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.391.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe7bde1dc9180365e794821f5dd901e572ff89bd5e6a286cc3bec129c73be780 |
|
MD5 | e6debe11be4987b18db95df0249ad62f |
|
BLAKE2b-256 | 508fdb4a7cc302c9fc70617b0150b85e007f82a78be530e815c5a68d0531f678 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.391-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7c33a360eb8c81f6c395231efd8d69da247b8a868ab20658067d7d31a3312998 |
|
MD5 | 85dbd023589a85de58d5979c5b8f8ba5 |
|
BLAKE2b-256 | af7cf81a29bcb5d9b8100b30bc7074c6d871b042fe76622a20fce81b534d2ae3 |