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.780.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c94d7a2fcecebba05b3b47ce51d743488ff781aefebcf177c6983a8fb467bfd2 |
|
MD5 | 0679e8e2d84cd9c0cfcc1035521b1890 |
|
BLAKE2b-256 | 71cdb7076bfdccc8532b84de0e1a710fdd343122f902f7f90f45bb9de9ebe116 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.780-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1bf6afcbb1f7523fe3678dfc800780e4b850a34fce02d6686d08ce8c6cdd90b6 |
|
MD5 | 17e77e99a4cdd95d2aba4332d041833b |
|
BLAKE2b-256 | ecf624614e3f70931729b11e54f80fb6d8093ebd51760e3a169ab43e6a5df358 |