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.272.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 09dfd7f00a34250f392a6ddfe931ea8a9687235f9b734734481e6be98f099445 |
|
MD5 | 7a021d14207f387f87bf615b1adb1c80 |
|
BLAKE2b-256 | c3d47cb7d67257a206325dcadc110f6ddd38661289b06f7757183f390ad406ee |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.272-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1005abf52629053754f7b391c703f9751a7e03d68973769f439c58ccecf557ed |
|
MD5 | 1699061773cd4a96ed4e8195d07bb76e |
|
BLAKE2b-256 | b1f672bbbb85aa44ebbd0836b413f4bd9d70f6e37083f6fe4125622c556c0a23 |