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.774.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 18197f893121c92c0b85f0213fb209faa8e6a632cadacce7ec450a476345d62e |
|
MD5 | 96951d018ace3f9faccae47888edc097 |
|
BLAKE2b-256 | 3abf44c06b1ab69b9bdd54952c80639f81ae24efa9bb86cf09e181c8d973deee |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.774-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b86301a288e7e0ac59ccd7e07345f3aadc90eb3b7146f42d53a87ff249028e5 |
|
MD5 | 94f16402b9bd4b1a50db9d4a5fcaedd5 |
|
BLAKE2b-256 | 775b86242c6eebe514c6d97a21b9851154c3d62cb83c14cfca58f72ac4e8c8d1 |