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.64.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 86047f33a28737e04817d48d426111cfe31152cc85e63555e39d1734b9da5a51 |
|
MD5 | 6155e1993cf9d437bcbca3ce4144b14d |
|
BLAKE2b-256 | b3424919647a0a7953b3e06c0fe5901d7a9d4886a0cbd08ef70bad9e63bbe35a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.64-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3733e31ff18538cf7556248867c5d920c281eda8a3cda37e7a529554bde3048a |
|
MD5 | 4ff16c243543fee887b87130f3cc37ef |
|
BLAKE2b-256 | 8b55e8ecf8e1fa10ed4168234fb8b1a8f524401e5526c6ad1e1d0365405759b7 |