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.881.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 692d1b3d2aaf16527da2b4ab82786759e84797e54a4a31161a67b873bf8f7d87 |
|
MD5 | c93e7190297b35aa664bf112f5f9ae94 |
|
BLAKE2b-256 | 93feafe0f9b7eb5681541ac99a62099f4b36f78a974048e1bd2fd2be304d3744 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.881-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0ecc8327782bba7b1d3578246cffb61c7fd5d42ee892502314c4a0fc9d3055dc |
|
MD5 | 163e0e976f12065ca5b5e89f552c8e80 |
|
BLAKE2b-256 | 0500e35a789f95c42cd652c36ea560b7093fd26e376173dae563120610e8929c |