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.468.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d4253549c0ee689075c2223ba1eee29b2173ed451dd154ab5b3f144c3af2dfc8 |
|
MD5 | 38b2bf2f976deaffb9bfe5ee9d81adcc |
|
BLAKE2b-256 | 41cc4abfd2594049b2321ddcec268e27862985a5ff457bdfabfa6fc367f3d032 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.468-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 903bb2dd147715b0d54f529f756ed09e68bcbaa5eb92dfee84875add2afd3aeb |
|
MD5 | 91e3dfd4fc1c99f07bd406cf395ddd1e |
|
BLAKE2b-256 | 77520d5526a9e7d91fa01cec05759a085d251ae5f9a95c7cdc7f048dbaf7634c |