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.621.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7998163cfb416dafe2c6b1f1f8de2078451c77a1fc941deb46376c9c3c590ded |
|
MD5 | 6727fd421466b75ae68cd003ec198cc6 |
|
BLAKE2b-256 | adec440d70800e9a8a0093a3431fe4107bf7b2b773db612c55184494ce292090 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.621-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d87aa5beda95507e2fdd16b6126cc0fdc9ba375d39e307b8970e5eb11e22807 |
|
MD5 | b33dff95e37e9804e18136618f0025fd |
|
BLAKE2b-256 | a56d00173464ff5a6cdfc307caa08cceba9e1368837381000b04d422dda2577b |