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.32.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6eac60b35de73cf902e5dedb3570f09d0641a1ddc74e8f6bcde675d44c32173f |
|
MD5 | 641c1ede9bae104632162013afdecee4 |
|
BLAKE2b-256 | e11944891d793a3045a8876658c14857b4a1b6f0cc3a332b5129dc2db46cf2f1 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.32-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c8c65703cde2661fa784521a224a2ed22ed776a506bfb1b07d56d8704a91f027 |
|
MD5 | 63ef5610e7dd5abf94dfef27a62eac2a |
|
BLAKE2b-256 | d727e38475f91cca24dbcd1b7505a356b525f9d6171dd222f0618969599add28 |