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.513.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e9da7705b03b8bce7d95e17ecf40285b4b3ec413053403e46d4c5877483b257 |
|
MD5 | b3a6f0e5ddb9efc239a684702e0c953f |
|
BLAKE2b-256 | 40df0431b9b6f019255bb55f3e2cf0ef96fbb7e9ad8d28eaeb5cfd6453b96571 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.513-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34eee477a5a98c9a0e9c1551938915efb9d099d9c4c721260d2c960e32109a26 |
|
MD5 | e493c4b9c4e8d2eac6a2ec6bf47b06d0 |
|
BLAKE2b-256 | f5072e56fdc91b8e473fa3da8eac4fab4184cb39338984a70e51fa91cb2bced1 |