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.315.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ed34d4409872f2b4a2640b3847de2d64bd99932206a120977dad48d36995cf3 |
|
MD5 | 6ed7c3584ca4899a72cd404b4f4f259a |
|
BLAKE2b-256 | 76706675b3e278bbde29b626a329204e760b3873741ae4efc3add89249c04025 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.315-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1fb76a14f8ac0b72b8f6ae4bc8007a9fa54da85d63ac61c8f2113b0e175e105 |
|
MD5 | 1f58815f40d0664a720492c9cacc440a |
|
BLAKE2b-256 | e1e331899f944958d5c0ee1a9272d480153dbe5bdc81e00652a6300665daeb19 |