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.70.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b0cf1da5e8778b80ab0427ca3340be5d0e8954b296d40dd022d4e65c8ea29db |
|
MD5 | 8170308ba6e3fba540dda744a04e5934 |
|
BLAKE2b-256 | 56215f898a94734fbb52c719fc473063be1d967cdbcfe2c78253ad6fafd9a437 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.70-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9bc86bb86f4045b0a1b326426796a648c5eeb27e200ff875749b9b5e1ad831e2 |
|
MD5 | 6646633117bac79a0b0b6457e08199f8 |
|
BLAKE2b-256 | e9767d3112aa4784b9a772204ea0c8c3f6af6571a2fe716e480d95d537b98567 |