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.509.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3999c1ffd20240cdf46f7597cb0e7e23e57035c119a70f1ed36b69509e2712c1 |
|
MD5 | 43b60b084eb88578643d5741e073a3b7 |
|
BLAKE2b-256 | 17d5efef1148bf599b0138f0f4ce586e0fa056deec466cee5ed4af93ad5c99ba |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.509-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3ef83335944e7fd0dede66bccb4f067ebdc1d7a9569f73a567868a1a8244068b |
|
MD5 | 47c2d02902169dcab0640c7a796fd319 |
|
BLAKE2b-256 | 6691f8342ecd8fce8d678462a941f0f48c5749c7327e4f22a1f576d33d23dbc4 |