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.678.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e2bf903201a9aba0596d9f0a6f53050f20109e00fae75980919474b34d76ce1 |
|
MD5 | 5ebf960e49828177292d3bc1d30afef3 |
|
BLAKE2b-256 | 0a5240261ce4c6780231ef0c7fa1810832e0e7b32c6fea850e15389e5ddd6ed3 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.678-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 040af09f5aef99f14bb999ffd6f65ecffa7c0a7b5e1fc4e89d507ffe024821be |
|
MD5 | 187e8752b8e8353dfbf574a1da1da872 |
|
BLAKE2b-256 | 9fe7be1deaa6021eaed02012b257539ae1bf963e12f7a1e7c44fe8fb38ed3f64 |