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.558.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9ef57ad08d8f068b3e0b82661c6e990147ae5be77d2c91f2ecd137710d6e3383 |
|
MD5 | de6d877426d66c931b68a94441991616 |
|
BLAKE2b-256 | 95b5eed405a3cef9ff966d4dde4e48e8ce1bb44112bfadc0ee29d634c34c3deb |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.558-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3ea03d3977e974cc6a5b13ff85397227a500ce348181191e9cca1408aa2509e1 |
|
MD5 | 4a85af300e7aac718ff368d03c93abf2 |
|
BLAKE2b-256 | 8095387b4ccd5e6784b438d482e5a92247484da6d89930a8bf3defa05d4b7c34 |