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.330.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1b616d6df430a1267fa6faa339d4ec911fb9fa1f214fa45c0f09968f021d397c |
|
MD5 | 1b4138ffba9155c7b1607672165dc98c |
|
BLAKE2b-256 | 3f6d3fb26bcbc0abd9cdd96833c292df724c84cb5d221f1299a9de3e51bafb60 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.330-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 46bc1ce3cde247041dc1d632d78e4d03952faeff1cc39a18e3475f74de2b417a |
|
MD5 | 3b0040fa31f61d3ab82760cc05aa9e85 |
|
BLAKE2b-256 | ddad4e3063890150b9d6f6d6c6224626331e00450f13bf8881441cc7a300f6ee |