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.799.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ef79bc7e937b78eba4fb21bef9aeb3ac0a61a067e6ba093bb6b98d4ac12f9f5c |
|
MD5 | e337cc216dcf080586f894090d766b34 |
|
BLAKE2b-256 | d5f574f82801799d492a2efbb24df0979c0f90fef2351d4ceaa33b62ff7e08b1 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.799-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bef1f542221e9263ea5d006250e6fe8cdf64c8170b88e6c20206710abaa1685d |
|
MD5 | f6a66161456435303d1dae0786b74e98 |
|
BLAKE2b-256 | 78ad9c8f82616e488bb57a7c49496caaaa3fb153a9e96fbc409a1b140ba36e88 |