Skip to main content

Add SwaggerUI to your AWS Apigateway RestApi

Project description

PRs Welcome GitHub npm (scoped) PyPI Nuget Sonatype Nexus (Releases) GitHub Workflow Status (branch) GitHub release (latest SemVer) Gitpod ready-to-code

CDK Apigateway SwaggerUI

Add SwaggerUI to your AWS Apigateway RestApi

SwaggerUI Example

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

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page