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.680.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b807a361376b3a8fc78f30235357c2e5abd87315765aa56f5112226323ea7aa4 |
|
MD5 | 3fad70768711daf596ee16162a731496 |
|
BLAKE2b-256 | 8ca99b7c772c4aaf7dc51f79fcc8b5835fb9f6c7ed6d8ac649bbd4640d4eb04d |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.680-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3bc16005297e0e9d32194a6374cb2aa97abeef416c42d7ed3ee2cb3d2d6a1c8a |
|
MD5 | 19e5c15f6e135539d6649d98601fd33f |
|
BLAKE2b-256 | 98358b5dca249e481cb7f69548079ce10c5906da478aab17f0417773c4c0311d |