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.196.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4a832202ebec29a6a903b06304e3c468a20c634b0056699b8a6538c8e06cb892 |
|
MD5 | 26f7279cb0355b0f62565b84623346a6 |
|
BLAKE2b-256 | 5b90e4e94cc4142d5c21fb34d00b465ec35aaf6c2d75738a45b48e5909a67f1e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.196-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9cb84f177f6662ce32c8c4dc836a46cbd61f2eee00b01a1435c10a1d33bd0652 |
|
MD5 | 4aac1c2042d1c5b557bd93b4865d39d6 |
|
BLAKE2b-256 | efa91359764e179bfa65daa1026de72fe99ce8ce9f43cf5d1c17ee1978d07554 |