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.490.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e3539b484a89931641d2b15bafb4a43c24c5fae4eabfb450fd010a386d92b0b |
|
MD5 | 2c4eb7f104fc5326db0a2324a288d1c0 |
|
BLAKE2b-256 | 9a1a364620332435e9f49a234e28885fb413b359c4e588f7488ab4e50428c893 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.490-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c2f3d599e1d9f083533d8a95c8febc84312b6a2e2adf86bb0b4b850957b2c893 |
|
MD5 | e8872ea2b2dea227e80e978bee05d2e0 |
|
BLAKE2b-256 | afdffdec9a1bbc5326b8b72cf0bff8d28aaf862d869417872c1d21f0eeb8b9c8 |