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.250.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 57f93df2e1e3c41d926ad631c1bd7212d3c941ff266d6551a9fb6fce1cd4b155 |
|
MD5 | 03434686a01562394640adbe300875e1 |
|
BLAKE2b-256 | 08df7e9baeb53ae3d9f051840765ea9acd330368e2fc46890be2ccdbbfa5ce6f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.250-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 875e4f9f20ccbd52f7dbb3d6e650e3f5c06fa092ba1b8e274023a8fe503ba03b |
|
MD5 | a8adc40e8e99b603a350a1ae267a3133 |
|
BLAKE2b-256 | 6aea5e6fcc38e0968b4808774e8ffbe041b5c0c48acb59dfe1b6c11b496719ef |