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.618.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 019cc05cb78bafb8a9c9aa197b06c1345a85183692937d46795a9af3d36273e0 |
|
MD5 | 6dd600e8e3ece7ae75c7e223c81ade61 |
|
BLAKE2b-256 | d6d3ff57d6ab83108903e98ddfd19e4ed80cb03d646ed7329cbab8a8f805743d |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.618-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 264c21ec36c32779b902ccf2a95d7e6210e75b3cca87f4ccf74cf81c2a3a39a0 |
|
MD5 | be5b2725fe414ab43509af016f246820 |
|
BLAKE2b-256 | e075e59ef42609076f1ebf43a98f6c8d4b5d2a9718c2865547e7a270c818d44f |