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.234.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a61a8c3ab7839d7b2c769ef6bcc90dbf4b71af621519ef2257287a8d34fb5493 |
|
MD5 | 890896920ab90e37da8b9d07e9060875 |
|
BLAKE2b-256 | 9b73a61f543882e33c01b274a3ebbec3465d03acb0d16d88627a1cbbffbc570d |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.234-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6bd0b5a8b097a05faef12b93f4bce79da48b344b6cfca3ce8fe5c7aafbc6f859 |
|
MD5 | 42ac6c71456852347da39ba9e20da688 |
|
BLAKE2b-256 | 87c870804c247eee1f1b7fb32524a82de35d8946291e26d0ae78f4e8fa63e399 |