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.892.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e80ef662c4685217d2cb30094763c66ade31693cdaa2aa5902cce739c26d2f1b |
|
MD5 | 92fdf94f1a28235e163ebfccf7c5cde1 |
|
BLAKE2b-256 | beb1fd05b675057acbdd76f4e7767b6925f3cbb8103b301c7e1b5c0319823cc2 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.892-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 08f3ea95630066211f460c6b35a85c0d40967ef0d136b8a76b5d090e7d6c3c1a |
|
MD5 | fc7469e9701255ce54667a8ee5baf541 |
|
BLAKE2b-256 | d44b8feb6381465aabee0af19c6947c2224323a94ff1f8cb69621ac60e922182 |