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.679.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae575a3476879d244340ecd2b76010a5acb0a473aa34c231cc52029a3de648aa |
|
MD5 | b21c325f66d5220ab7ba5a6e4efbaa2f |
|
BLAKE2b-256 | 2e2eb1c039cbb3fc277643ae261f5f03e01014731f1668e8e5f2afd804638a1c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.679-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d24bc8439d6c78182f047dde0977b9c537fae2c4940c7ae4a02f63a1d01cd00d |
|
MD5 | e0ae5bbc137e488a0d6840ad5f632dab |
|
BLAKE2b-256 | 53f2a65dc1e82dbe8f84ce3d972f545b42766a5a113ff8e271e5faa037f648de |