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.169.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 23488020d514a19944083caf4a11fad77f8bb4e82428d3bbba0ea63d3c686fe9 |
|
MD5 | 2bdae7646c52e5bd8f8c17ecbb18506a |
|
BLAKE2b-256 | 4c774c4ca514da0307079c5ca2ef2b4e785cee5e1e6fcb456f37826e1903a7f6 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.169-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 68469931ca4927641de0cb9e26df72288ccbb266d1e78a2853fcbb5f54303ba3 |
|
MD5 | a755ccf50a47476da345f6508aca1d5b |
|
BLAKE2b-256 | 549f92e7f8ddec6d6354192a4060ce3e80fa8e3bac683ffae836eb651583c9a2 |