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.94.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d81d49e3a1af5b1d30489a577583aaeff248758b47bf793c7a7935b52e8252d5 |
|
MD5 | 111fdd16165d51ae7dfd3646bc426206 |
|
BLAKE2b-256 | f1b6bf2bcb6f354a8efafe77ca3fecca91b3b97fca7f132173e688dada8d2e70 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.94-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a4418caa3d0c590382e28a9ab640d0bbbedef03fc401005fdb7e3ec6a06dd2d2 |
|
MD5 | 22a37bec0a5dc49d3c1c6bbb9a9e5f65 |
|
BLAKE2b-256 | fcb989e3978444cc80d422a3ba9a89107a8e7560afdb877c4ed7f635ae753ac3 |