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.261.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf3f5b9607bf41a1bedeea03d235aead3f1698d751e0edf68dc13b34708f2242 |
|
MD5 | 543bd3b85f3466297014bea87f4cb190 |
|
BLAKE2b-256 | 85b6383b317ad0389306f86462ffeebe215e014a439979dba0d64aedfbba9b41 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.261-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a7d4a2ed30579d3beb1feada33d13b74d89d7f28d7b82d0c6feaec8d131bd7a4 |
|
MD5 | a2e665c5e4393ee4026b0d7d01f61f5d |
|
BLAKE2b-256 | 7e9671809fd72833108a16286f0b5ac3c9dd5ca867d26ed4ecae1c9fa45ff2cd |