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.923.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 38435cfb8311daf45da6aa41ccd6d97e0f30e952406880a6d6d69f9748dc9dc5 |
|
MD5 | 41a1c7def2e2a6bba7751c66e01f2faf |
|
BLAKE2b-256 | 49a5f651be84a5f356106b73f11e5ec43bea2564dcf93dfb48d68563e2dcab3a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.923-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b5a646f2d37e296023ffab1264255d0a7810a877fdf52621c8ddc8fb53cc7254 |
|
MD5 | afc156e9110affe8d7e22b5246ae2701 |
|
BLAKE2b-256 | 1a8e76791cfe6c674f34cf7d0559675990ab4f4fd7cb08e74b9dc17f1d8577e0 |