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.302.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3f4c2db8e49df5bb28016e70806bb7d5aa91912a25989323798883859ebd8e40 |
|
MD5 | 2759888871fc0c58237ac6d8d1ae2f0f |
|
BLAKE2b-256 | e434565e5a6d511cabbfe6ffaf6f196cfff44610f7e507a958b9f693c34a8abe |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.302-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 35500c272bb47e0ed0e401cc69fb8d1707824503e5df1a3339b25a8c869a20c8 |
|
MD5 | e4bed4f1cc56e175afc3d26723441277 |
|
BLAKE2b-256 | 97b736d7c8da61630383db3bdd72a163ce1618d4f0b3b3d7d79eece871473448 |