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.493.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ecc97b6234ac19565eef3926f187c09d87f418bb0f57c5dadd8ab4e7d63a40c7 |
|
MD5 | 6591d07dd0e5932d24ca44bd37e4c648 |
|
BLAKE2b-256 | 80e75f43cfeb797f256853548c77ba7186bf94dead3ccbd96b786ffd25375a3a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.493-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 35a41eabc599adfc1b6d0e042d2a3639045ffc5db3289de9b3e32a083bf6b18b |
|
MD5 | aceb4f83f99b5843717020eb69d2660d |
|
BLAKE2b-256 | 1fd70aca92a8cf39c328f868787e9775c2a7aacc0c786e186c832b147f1dd0a8 |