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.801.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c9fa2bba22e8d82d02c9ed5d1148ace2451c45bcf2b7b4373af46c1519c2cdb |
|
MD5 | b10c2553f71eeec52fb430f192bf58a8 |
|
BLAKE2b-256 | 517111dffa7f321d39a137a6eed18a67e2f0560557103fd9d261deaef640d7d2 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.801-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a0583b08806333df26c7f27be18b6acf566ca780996f2d7251e2a230994c53d |
|
MD5 | f88bcfb7bd8c1ff19de0f89d96b4e739 |
|
BLAKE2b-256 | a0001b444a60a21362bafa8215dd7d505c8f508fa6c3796ea0bf09c1dae1e844 |