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.263.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d4815e3e326053ebe22dbb8d84350939ad474ef13a26ac3c54e43e152749c0d |
|
MD5 | aa885afb0dbea380972303d25ebb5e9b |
|
BLAKE2b-256 | 342152620bad3a652d1304e75730497f43788f54b0d244386e596908a1fee7a4 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.263-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e93c50511d9d852d8e8d4574fcaf6055df4f64852e7f60f279265ab83ebfb6e |
|
MD5 | 23a13a3c124db588bcdae652b9119d5f |
|
BLAKE2b-256 | 28c4e99f5ae7c2ecd99fd8f7ca61d50cc407744959051040b0214518ddd30849 |