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.571.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | aebb7c63031c861160e57cb2f744f023dc5de5ca6a722eea0097e100b003961b |
|
MD5 | 8966e9ca0e0187abc3689f8c9ea4c605 |
|
BLAKE2b-256 | db2e9eaf585c77fa5c393c1a9b880dea526ad994d461eacb169d6cbc6c5ff032 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.571-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7c1397d8a08c8c91a02bed7f066a4d3006b40a739fa1b8e1e72cb9bedc8b6303 |
|
MD5 | ad7d2592ef5b552f1760f5f1120c9c65 |
|
BLAKE2b-256 | 30d7b61072fab8e0d39c7ce2add9e57684e2059e1c916d645eb0466c0fea28ad |