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.212.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7550d2877406acfb35edf28b283ec0ec71e14f20f112c2ec8fcbf421b7febc1c |
|
MD5 | 542811bb2554b431f4cc8c0690f5fe56 |
|
BLAKE2b-256 | 5f737287d7762ee8aec69b50103306b613becfa47446ee1d78ac920153a25543 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.212-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6a031d337cbdc70c9c3d119eeb74223355f4fb5f4b4284a4f18e42c4ccbea5d2 |
|
MD5 | 8b0013946e35bd3b6562d49ac3e7c677 |
|
BLAKE2b-256 | 67479e6a40ba6a0124b42e870780b9bf122db27796d53e51a224fcc9b2504fc4 |