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.811.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 710d02ba81693faaa35852c831866c7d7bdb6078d0c8cc320c597a00eecd5595 |
|
MD5 | d09691ad583df705439127996bf327d7 |
|
BLAKE2b-256 | 2496f32f9f840d75a212cd5338eedf9e3e4fb69666b3c35c44567cfd1d19b35d |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.811-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 887f10444ee380787beaf78860d454b9261755be70a60941a274be805b21ce32 |
|
MD5 | a79ce7f66c344901ab3c3e327248bb5e |
|
BLAKE2b-256 | 2b163069e626981556ed7392a6c09d54dd6cd6d6a4b9ab786bd0408f6440ff63 |