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.861.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2ef431b0e465ec90b211196e92d3c68f8c66d9809701dcd77d7de45b55bb71ee |
|
MD5 | 0362e35d886a923b2b5a82d42af7eff3 |
|
BLAKE2b-256 | 8d2e749884eb0db34ad10d3c8c4ba5a74a592bd0607e02b6dc64f9aed3361ccc |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.861-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eda137f9aacbaadd5e0bcd567b7ab7ee30265aea034eaea65af56a24a773ef0b |
|
MD5 | 4a2515dc1ad7743c4209af95b9a208e9 |
|
BLAKE2b-256 | 237c6bf2cd40ac7e1cdc5eeeb52a65414c94994e21814a15e948005d936a2073 |