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.875.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7979cfaaa6035c119a8941b4064d319ba4a6e263d4dddab1da33e44318c13a02 |
|
MD5 | 6357dc80672231b8be1600109c70ca16 |
|
BLAKE2b-256 | 7b442795ac28570b8bf41f4b736227950b2ba91b6a2811372a5fc1fd9c19ba20 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.875-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | daccaf52118ea3e25aab5fda80314cbd4c3c60e82cb928890d20ffa1b0ee055a |
|
MD5 | 5429aa22d45bae4810a1595dc55f92ba |
|
BLAKE2b-256 | 0f24176394736b4e010a699aaf70eeed0b0b019f1663a92da43e4a68b06e0a85 |