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.25.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f1c20015e5c7916a3baa2d35bee66882efce17564550d591fdd6f7374a42fa5 |
|
MD5 | 8a952cd2e5bc4688569cf173a2e1b6f6 |
|
BLAKE2b-256 | 71100cd9447a44727741d8a1df1cb5d3ac387377559a2635e61fa31c6b06d651 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.25-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34e2c5b139e70f6856bab8aad8eee02ace63a5578882feff32a76b5b931f2bd4 |
|
MD5 | d66352a30c08d36fd4e95d22563a8ced |
|
BLAKE2b-256 | 394b891cfa090182a20c242a6f4b595799ac4ea8f586db654d5670810b12bdc8 |