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.854.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a7997b416b1a8e65164eeaee482906a01ec61c9f5f0606380f080ad431d57868 |
|
MD5 | daedd3bed13cfbd9b61c776df36d865a |
|
BLAKE2b-256 | 65788c61bca7add00193b6622c56680e2bac0c04f081e795502523da5d6ceded |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.854-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 437c01dd171ebcfd51f1da9e4e24953e9bfefe6e0eb46c0601300e8ad55f0572 |
|
MD5 | 52c8aa086dd63958027a631cb077abb9 |
|
BLAKE2b-256 | 5d5f82b3b355c1e144209bacf5d592e06ccb7d3b961d9c06a51b0ea57fa69f9d |