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.198.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e25618a8a579d88b729792fd987a4a6607cd9990dbdde5c01dff72039293a04d |
|
MD5 | ee8b8aec9747e8541261bf1f690e248a |
|
BLAKE2b-256 | 748491829d138c86a3ccc0d531d104a11cfec749bc53165958d37db5954e6d9f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.198-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e096a2a5632355e24b6205c6875d042fbb32b10a7d707c00b92bae7f5566734a |
|
MD5 | aa279541df2be1b297188d369fd82f93 |
|
BLAKE2b-256 | 35a3a008e5702024e859e990d9d1a1301e0bf5c040288f07b2f095db0da7b25b |