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.344.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d17a6e7ea1544f2b24759e2344d5f4258e882cbfa2075f62f10d85ad42d3fcd |
|
MD5 | e8bd3b6cf1380acea9018b071e10a71c |
|
BLAKE2b-256 | 1b387353219c22213caea772482f36172c8f2f387f83ef42dbed592932d36df8 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.344-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 000078399a38574f0264b28419d2cf9a2df441a6238931094d246a9b1993df53 |
|
MD5 | 4f833e3283b9db4d36bbdc31033608ba |
|
BLAKE2b-256 | bfd747364757bd28d8b6638ce86f3048482f8dbb1a619430b8367153bcc6a921 |