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.445.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | da65f451b7cd96ef38981406f634f373eb29af6bed33401325119efb25a6b041 |
|
MD5 | 6e08f7ecd6eb0c7ff243563ab9b68f20 |
|
BLAKE2b-256 | 75e588c51ba42215fa3ae76dfbc1f1a65c0d3b290f524235ebe9dc7b8f131a47 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.445-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8bde70618b2768a6b458fef167f4957be6055a4355a2a3ffd884756cbfa6e810 |
|
MD5 | 839f676ecc04d2eae9742da8585a7cca |
|
BLAKE2b-256 | 76b6a626485c2d9f0eff5ca80f1b3dee134995b059b5e779c3f34411725bc7b3 |