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.379.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4a97e0be35b3f75ef0ed3302f1ee01339ac7faa2b01d890a18bdcccd516a2f49 |
|
MD5 | fdce7dbf87f33485aebd4e5b22d0f630 |
|
BLAKE2b-256 | a18470c8fd8c44bbb2f00f14d988f2df855e0276f9c59725e4f6b5e4ab20fdd1 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.379-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 233b5d9384079843c0376e5b72943cd0b5e0ebb8f4a610a63ecf1c20a2e44442 |
|
MD5 | c99f5ea3f10d41565a666d3151b60346 |
|
BLAKE2b-256 | 090a74923c0187f44245d7193d3cb1f0b3a53e1c70438e501180b0437c89c7d6 |