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.405.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 08c9bfa0c851d6cb653f8beb15f09424dfdaef69abb57c1f574f0a0469df5ef2 |
|
MD5 | bc43924148446be4331c8bc30a4aeace |
|
BLAKE2b-256 | 3dbb7a8a5895d2bf68ec31b32095704e18b4b57f83d46bfab0fc5f32a434e354 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.405-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 563f172f57d83fd6fa354784d27e548d2bbadf5a793b45d321ade3be10a6aab7 |
|
MD5 | 02a57c093805b0e3f1b733d4c4a3da72 |
|
BLAKE2b-256 | 75f7e2cd396e117aef95a0078aa4fc5cdb2b3b33ea0a3c888d2679f4e4521630 |