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.560.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a62c0b5e16b253c954040254bff790e07596b5d9f331249d3dd6e59579d5b76 |
|
MD5 | 664a8b7bea14d748332137f8fbd49de9 |
|
BLAKE2b-256 | 65596b00b0475e06e5babab4a65e99f680af3956569b523cc3c2a2a56de83c56 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.560-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd910ce6c22d94816b2a28dec534e574ddf25dcaf40fd6e40255f6090e5eb60b |
|
MD5 | 58e060d8a4c463d257fc6502d51d8a79 |
|
BLAKE2b-256 | c01f4cebac2e6cdf76d62c893ef4e6f9fd48e01d608ad27bbc5856d5171ffed8 |