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.867.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a4861e77ed088c96882096fdfbbbdb5b3ac10629b802ac5108610bdfe155663f |
|
MD5 | f74de02668c04fa370ed93bec95b78a7 |
|
BLAKE2b-256 | c6cc4dc4d2c5f4af70bc77d50a7e0940040c8eea263eef446e5b29266702b9bb |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.867-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 736860d9315da2a38a5a6d0f045d9024f91ecff80739a7a9941078b93a5b8b78 |
|
MD5 | 7461ad9cf72faf83aa9ae1d9076aa652 |
|
BLAKE2b-256 | 9650914382d4b724c38a2bf24900bb52e869d54f096594da51d2ad75c792b556 |