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.109.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0373022ec70a6d12e6787a381c69b035630044b7e3e01b43214de475ac851d7 |
|
MD5 | 8457bc4f5c5157b759fcf79b3952b1d4 |
|
BLAKE2b-256 | cd69fd989a384c9118753a55034d11c1ecd9bdad8ce712a05a08a3508058c2e4 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.109-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c864e2b77de76869c2ddfbb721016ea308c22c5e93e436082f2f1ccd9e05338d |
|
MD5 | f495db6f3f5d8374c1fa2c5ebb768cf8 |
|
BLAKE2b-256 | 0e32eaaa1e4fdde57856e6278affd352a12ed89bd6397abef32c5e2cd935259d |