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.857.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e39e45462b3efe85e7bff7e9a5f6c7871106818cd1d8f3a0259078b8fbc91ad |
|
MD5 | 8ecd2649c83a8be39c0adaa2c3449942 |
|
BLAKE2b-256 | d0714db951d03b8ba5f7df183aa65d1f27ddea33c3809d0654b0e00ea148c520 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.857-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbb2ebcfd47cfd96717ff8acd4e3aaa8075cf96561442e59e3d51e9305b67563 |
|
MD5 | d7249b5ca52448bef4887628b3a3453f |
|
BLAKE2b-256 | 880272831a6056b52313119baeb287d7ff34a70d477fec69640ad95f9a4c977f |