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.523.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 973c4518ae16955af80070d9dfa529ec73b8ecd07fcba4fc8fd124df963be90b |
|
MD5 | ef8c7433edc2b09b0d33c525d787757e |
|
BLAKE2b-256 | 38b9eb919e6f88d2100826137dd7d76051060a0602cfbf8cd68325c57d2249f5 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.523-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | db689fa379e21ba95fd0b02ff923971dca1d771c95c805144704b2b697ccf42e |
|
MD5 | 6667710f87ffcce16329c09fed6e1f88 |
|
BLAKE2b-256 | 3716fd1f41760067287c614c22313fc42581d2ccc2a1d511d00348059a390d4e |