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.529.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 536f091c721b6ca7191c04d7a7f558e0a9f1fbb68368e05f62802dee8263d505 |
|
MD5 | c867c259583ec79612dfcb338928e813 |
|
BLAKE2b-256 | 7992a44181cf80558cc8b9a111ec46026d0012c3dc756c23d9c5598457e2066b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.529-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 92c827c8df640e751fe71844206e0ae6eff6233a3bbcf89a3b4632386a215963 |
|
MD5 | 62ce8d627c048d0f4c01da1b583b3fd6 |
|
BLAKE2b-256 | 22b6c8e80d720c49c8d6d407cd51802be6bc7d39d4a7ba6786876616755be5ab |