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.170.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e635fc7db7d3266d301b07caa4bd2eaee014819e94817bf8526cbb664e34780 |
|
MD5 | 5f040ef09b4f86fd229738eba035f431 |
|
BLAKE2b-256 | 18360a938e2cfce5f279f265b825a575861b53e27d3b8cf68101774b77dcc6a3 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.170-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b2eef40618f5711bd93b1338af6699917767405746343ac288776017e5b20b9 |
|
MD5 | 06d69b9d0c38e55e211daa91b7de355a |
|
BLAKE2b-256 | 81cc0fcefc85995748873f271df9e0af6793aabab41787c7a61ba8d195eee5e8 |