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.504.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d2138888afc89d91b024c0690f38f0bad96b5c986c0021f88276e87d950a8540 |
|
MD5 | 6559e5bcd5edeafb291f5029f918c44e |
|
BLAKE2b-256 | 1509f0984e638a90b0ca004a502fd99d401a3510f8a653cff598539890ef9c94 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.504-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e12385a5296ce25f031e17d07ed272dc27b3cab13b4ed76ba32f099f0c2450e0 |
|
MD5 | b71e435655cc29a053a69447d9fe6366 |
|
BLAKE2b-256 | a634fce37b54c9cdda5e171d2e8333dc139c8f3759d797a67855b7a78cc95e15 |