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.220.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b95b20d57f1d028b8ea640bc47b4e54600d81bde21c3448d1754c10b3270e56 |
|
MD5 | 2cd26a81bcd3453cbf49dfb17b2c3aef |
|
BLAKE2b-256 | 81ac5251ca439859960d4a599eb95bb160d1a5fdc96c80ae56ea728f9c71e706 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.220-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | edb37de0236681973c2cfc5d62966aab87a2faa14832296730596563161ad9c3 |
|
MD5 | 1dc3c3a11dfc540e8e5e55d8ad1e836d |
|
BLAKE2b-256 | 2df08a984c36dc73b5deb8abb4ab8eb4f03949d20d422bdfeee2a99ed47c539c |