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.510.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e30c8e7c4047cb34c0a4a0a75867282861bed786ba1a54d3812c188a7839a9b |
|
MD5 | 9a1abc0818a87af974a57595de16370c |
|
BLAKE2b-256 | 2163d40a676e30abfb4a5c937c6861816c696842ca0405876849031d5da42977 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.510-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 21ca17e85d0899b4c624d4299d45d6b3e6c65e100f89b61f5a180c1509b1ad99 |
|
MD5 | 8cd8c9f12774dab13ebd3367ced3101c |
|
BLAKE2b-256 | 5c8cd17e951a7275fd9ce09a99ca8eb495333133f60a0c0347d7e5fb27ba15e8 |