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.828.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7fbff55fcdb11ecb15355d6714c4ccb42381e54688f976f3e21f1d5718474d2b |
|
MD5 | 8e405ca94162faec131a4f52a41642cb |
|
BLAKE2b-256 | f772798cb0229649bd1500f4265a075cb6516bb2aaa01a6cc5c0ef98e90db747 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.828-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 262b98252856c2c2cebcfdedf929658eff4e8e67cc8d5add9795db8b01985020 |
|
MD5 | b4994d31a71b220384fef5fc94404326 |
|
BLAKE2b-256 | 92a26616e8ce62c4dcc63b7861c0f7b05174f9f19d4e7f68db4643d5428a6d4c |