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.97.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca052790ea1f6ba148d9fa550631253523a9f09385ee354be65d88b602ab2459 |
|
MD5 | 930a72b67c0c1344786b0ce4ae405ab4 |
|
BLAKE2b-256 | b54b0742a4ab14bdc0e7e1a1efa5e089f45c05c18e939582e562ff5095837d67 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.97-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7f62c67350029b6d5177de4f55e2242be003693aaa19612844422c83608985a1 |
|
MD5 | cdc337c5e1959608e68fc27f7d0738e7 |
|
BLAKE2b-256 | 0a08bb15ad48a56cc7bee5957b5dd361798f441a2ab3b5137a6afb1fe0ba99eb |