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.719.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5c5075aa6470be2492d8da01fd35095b301acd32d046cb3ec77324a2f4f7d5e1 |
|
MD5 | 01b8df1540269ea7ed3423d7a9f458f8 |
|
BLAKE2b-256 | cbf94c71bd34a2e45ab0bc6c23523d8129e3a7bcbd6f8f444209c4ae1ce1fa27 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.719-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 613cc76cbaa01fc95570ce11a4c2506dd3c2a307d10fe64f89724ceef54f675b |
|
MD5 | 7e3fb6ec1abcf1fd250f554b9d703fb1 |
|
BLAKE2b-256 | dd7f88aa10cb02c91b4f834d803ef4b739e43aa692573eef408ae7e73b8fbb9b |