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.306.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 698e18969843924cd8b488da1f87b427c792a70f1faea05d612c73703a6ba658 |
|
MD5 | 4dff91a7838f6fca1918e470095ba944 |
|
BLAKE2b-256 | 23dbb98d9020df4b8a7c9c90a2397183cc594c4741746625c330bc0bc384fedb |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.306-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a4ac319bd429174591041d88352d9416387efee6188b9b3e20f33cc7c0b96212 |
|
MD5 | 0ee9094f517203fe0ea0da90b673bb9f |
|
BLAKE2b-256 | 31357ad28680ec74e248cb5bb51776817ed36f9fb7ff2ad79742905de26e92c8 |