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.40.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb8775962d34edb5b9bee4ca4027b5b259513b7f6a8ff4ce9fe762cfdf415b60 |
|
MD5 | 9e2ec988bb9637be52ec1c0e678bd1b3 |
|
BLAKE2b-256 | 8117fff7f5183204877666d59900bab1183e17f87be11aca3ee61f2ade96f947 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.40-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9ab7c2f9aaa2150f45782de21a8a27734ef16f4b4e9d797437ce37a136073ad9 |
|
MD5 | d9afb5149e01e5d5c118237ead302089 |
|
BLAKE2b-256 | 8a4b2d0d9645bdbfd48790d244ae3117e0124de969f529c122a9d790033343c5 |