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.791.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee2821f6cd8839a61c4368bd571c8dd110eb6a36d23d2ad5a273e1c16a66e453 |
|
MD5 | 85821b6978fa71d43c0fad9311a9dc74 |
|
BLAKE2b-256 | f236b1633a33969bead94d96fb3e56979fa9a85112dd819d86c5b5b1e94781e5 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.791-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fbee466dde29d62dca21834b611c2e6ba1a653d5291eea07403a7ca81be939b7 |
|
MD5 | 8f7306f54a82ab4465e249f5afd66c98 |
|
BLAKE2b-256 | 58635b9d579d507a1df478cb20b236d974dd2e399946b7f1f5ae45493ecbeb20 |