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.408.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 59ed03db8298a4c0b49d0fd4746becebfe2c362e38d575cdf3399a84b35fed0e |
|
MD5 | 01fae3774a7deb77d31def8e302c0e38 |
|
BLAKE2b-256 | d67fbb9c602a234c8771ff30767f8f0ff3719532b0f3efde27d7deaeefc9599c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.408-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eec67b2c4e7968397f2872734ff01ccf8ba772548a257dea4894c55e7708891f |
|
MD5 | 57251bc8001d60f68187e1274aa14f07 |
|
BLAKE2b-256 | 338404b3512e8312d15532cb000fdc4b89b3852413be374f452b3705fb2bfcbd |