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.340.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7b25c1c6327d7cac28a05ab67abfa92196f686b68b44719a87c01c3a09ef259f |
|
MD5 | 9515a7512efdf9dbd0cd5a9458752b7f |
|
BLAKE2b-256 | 08c2a2782022a749daa19f3f328d0226e147adf01a6aa6644e3e0b03c467f42e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.340-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 490348b7ed775da4fa873f3d3c69e3e50a78f9138c59dee4885ad90a8eca1db4 |
|
MD5 | a26909254eda41954429460d8f3b03da |
|
BLAKE2b-256 | ab3a91288b4673eceef5ae54b2e705dc67d49f9e824dbb3e54546f0f7491af0f |