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.862.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 827686f5ea12290f09cf96ecdaa370db11e865c849ccb8f206ddd2bd61e63502 |
|
MD5 | c42690610ff9230b7aef23ec85da3372 |
|
BLAKE2b-256 | 058c03b604307cba097151eee125743758d222d11adddfa28c2fe61d3c7417f6 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.862-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c9f5095bb8fd7cc6acdd8cd6d5d8781e4f69f8c97f58f6c46964e6d03b01386d |
|
MD5 | d01797fc4fa1602d71f79bfc8cffe196 |
|
BLAKE2b-256 | d6e45878dfa600eab6337589433da7e9cb6d0ea820b008cf447e8c4c3e897b45 |