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.288.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 943927393bf855fe82487fa3a33d57f9dfe69387cd6f48c095185cec1708bd08 |
|
MD5 | 2623ea35ed3bec0f4a7ef702ff0913de |
|
BLAKE2b-256 | 04357aac9a63cdefe1f176910c37e0ceddcbc076c242bae9d745e0cf4d6c388e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.288-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 917c1820a6f5fc7e164571848553f44503754a0de43fac5dabc554f570b6a9e5 |
|
MD5 | def7c7a514614e324a27aab4e7e2deb6 |
|
BLAKE2b-256 | 6ad8d0d3893a7c58f36d8bdf8707c93c97a54ba390d6b44fd5b02a9a2f13c27d |