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.550.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 16bddf59e0f77bd5cb91f510a3c62eaf6483d545b6d455b0e1035d4fb338af3a |
|
MD5 | 0b47cef193f7d623b3031cc8e9c2bdb9 |
|
BLAKE2b-256 | 82b23baecdf279e95f865f13f47557b14dac7b04fe0b61f337cb2948ea25b567 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.550-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b4e741442cae488e45aca46ef03dc58e30513f4f93280f835c5493ff000b67c4 |
|
MD5 | d45bcc11500909c0b0a96de1f4cb42ff |
|
BLAKE2b-256 | cff1cdb83c200b78650a6eddb3d8001a73b30376bba806830fda97395395e537 |