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.762.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e8f6b7177e79804d0ce62db169fe0811afb07203be0f8c30880185ba1420567 |
|
MD5 | 3e167ea28f128840937aba3c4ca83258 |
|
BLAKE2b-256 | 11bac78a068617394df40955fd0fe1e9efcb3efbd2b0f0e3e3f7c2d10264570a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.762-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 20e031412bfddcb29acdf38b0ac444e27afef356799fbde9a21e4e00c4bcffb5 |
|
MD5 | f939653f5048e398fe963ecb81154552 |
|
BLAKE2b-256 | 8881ca887ae8080a1a3d18f5d2f6af683765bc06546d6acc2328ba0f9582049a |