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.878.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8e5bb8956f970be6e16d5474e6210105c9539905f4432bc9f08a5c92e2090a9b |
|
MD5 | 930d066e9b3bbbcf439081cf44105610 |
|
BLAKE2b-256 | 96e81b10ad6ac6e7f283b92cd6302da1444f7c8803e14306846af7224c2706c1 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.878-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 461e5a78dbcd3ae31894b8a90867ab433520e4facdf95f1070632267905de327 |
|
MD5 | e9febc5b115d09b8422ea89ddc5471b9 |
|
BLAKE2b-256 | 9c4c7d6d68167b51af8f5b3552869002b46df453622bd7afb5411ac0b5cef040 |