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.316.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc3ef293596d15f1d22ef472812d35de012a14a5978d2b8ff35e693a87568a44 |
|
MD5 | 8575fa3ea544910b2fa352e4c45f7a6f |
|
BLAKE2b-256 | 8c39d1fd574d53fc3181b88e49cf69036914201bbb0413004c9ef9d879cd1891 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.316-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1fe5fa6b6bed05094afff4cec8707086662dc87936bdb2c60948790405635ffa |
|
MD5 | 7927861dbfbca4ce19ea2c8897a20451 |
|
BLAKE2b-256 | d368b72961e6196e11a59236bdd068be0fd2eb6efde14ffa28308748e6e1267e |