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.375.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 405417f35691bbd5b4cb3ed02f2a0a2b28d6891ad06c8d99218cae0021acb8d7 |
|
MD5 | 60dc9d0fbcba423f3da38813b3244ffd |
|
BLAKE2b-256 | 9c2e3511885e53c9319b558a5abd8889e5b2550b1dbdbb4f76c11c60058d1ef6 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.375-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f7916163b45d4b626fba3b6554663c169c3c90d2d907ad904c0efa18ce1d8624 |
|
MD5 | 6f33ed02137c7e353ba9c1e1474f6e59 |
|
BLAKE2b-256 | 531121b18ad9601736a50a88e0249282ae44ac22b832dd59a5b32184e66f9e06 |