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.749.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 144bafaa6c3111bd52cb19581b1ad1ae6423c2be1bcc8cc776cb9a1868011ca0 |
|
MD5 | 8492976fcf081329de6dffa548204b99 |
|
BLAKE2b-256 | c63e97fe90433cb0457372064c8471eb33046118cd4db7be15fe2df8aa49af98 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.749-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bdc840440d8cde09a3b144c531589a4c82549b9b81755c7fada5d116ce9bfbb6 |
|
MD5 | 2e490da89f5a02625d9c39600b5acdf1 |
|
BLAKE2b-256 | 5728481239edb541ef0a444d4b383584c7af58e56b59ec6dc209096cc747d0fd |