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.827.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a06d48296561f6aeafcbfc8b61f7d9196363b895da2d5a37d329faa1d4dd4987 |
|
MD5 | a24389de7f3d9a425c7bd159acb3fdff |
|
BLAKE2b-256 | 55fdbd7c719b708402f598b71f00fec61a8789e4950df25b7a1dab575049857b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.827-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d3da076c927b029100f1f151e1554422ae3d6f96279d4648c35dab6e7a9aa6d |
|
MD5 | 3b726b0f2c38202e52977151c16eb0b9 |
|
BLAKE2b-256 | 056df6a4923c6d39617d360985ec37855828618612324847d0a6407f9f04c2d7 |