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.254.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 92d39f3debd4791e6825fd45549a02595977eab0d3a38483fb8169424488dd97 |
|
MD5 | 455b4085f61a54a6e024bee329d9bf16 |
|
BLAKE2b-256 | f74ca3293ac68d4a35ffae6ffbcf3741b1ba98dbe57d60080649b3de2e8f0691 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.254-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a2f10d2f30ec4969f4c19b2b71eb6e969c252fbdeaeea3f12d4eec9af8202135 |
|
MD5 | b10c574fefcd0155b026114e1ce13fa8 |
|
BLAKE2b-256 | 1300810aad0c6fc3cfdefbd778dda0ac894f61009ba4436d2f424a97da68caa4 |