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.259.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d4cc7790f5f3b9a1b21df4651159fb2cbcd759d567fe1db2235646e5768a4a7 |
|
MD5 | 9da1229e2ad2a4e10bec8e79ca429d8c |
|
BLAKE2b-256 | 6e323e996f91da09554b86251fa9caccc90c8942e27df83659395565f768b053 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.259-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c002e2a9466682e02b0ec1cc8b084278a77ab756a3c323150889432258e89306 |
|
MD5 | 788c35ab86cf50aaaffa51789611f0db |
|
BLAKE2b-256 | c0bb7c9a9404c6bb87b887e4f8c664892e1386614a7e9401df536ddd96deaf7a |