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.77.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1bb87c22d49645babae68c7cc9d087c975939a04d86c1a35ab2a3f8e7c7d9c9e |
|
MD5 | e921985ee2f22e146ee3195dea5ae42d |
|
BLAKE2b-256 | 32784ea07b121875e90c71f90ada6e4adfdf40b827a2e1e1df18d102ac7a3828 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.77-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5cd57a641c6c75fb45a11af68f72a38412ab494ed5ad8b2e0665a494d92507aa |
|
MD5 | 883b4cebc91dcd9d5f5b617f29058f04 |
|
BLAKE2b-256 | 1aba4dcbcd0ac862661ec619e40707db13261adfb39118941c948bb2092feefe |