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.160.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 957493dbfdac725315330168203646328e761f1cbd65312bc8a50fbc5f2456b8 |
|
MD5 | a3723532060603ada157305b7cfce461 |
|
BLAKE2b-256 | 80c330f41a0522c6df21ff19308a3301727c4d7bbe425fe2e7924551d616aa6a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.160-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a09fbd0cdb5ed8cdfbb94b4009f80d5cef486e714d765c115b90d119adf8275e |
|
MD5 | 4ef66d46e7027c9a952a2836d7e0001e |
|
BLAKE2b-256 | 94a3a9267d9122fa1d481e085c13d9676e58410cfc9ec864f94c70732a3128b1 |