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.350.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5139be3e1e97cf9c917893a743d79856f71668a6a4b149b9b28caefd5a4c6a0a |
|
MD5 | 8f6dc6b9aeff0ea2ec58f93805baa718 |
|
BLAKE2b-256 | 50ba4996579a845a008d606b553b5968e501e244153cdde88ea0017fef1b51e8 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.350-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 930aa3cef8210a3e561ceab43beec558ec9ac127fbee4be1026de70c678862bb |
|
MD5 | f6241f79edb59ede4c7e9ed39ba13105 |
|
BLAKE2b-256 | 1d4cbde35fd2a18c3b7a8105779fce0f62d96a189871b5c44f29694815efe865 |