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.491.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3efc10e52d4755bd4e24e7d4d8befd8fc1920b04e4b428aa4d2145f7cfb7f652 |
|
MD5 | bf693bac11e946be2e1951d25fa0d7b5 |
|
BLAKE2b-256 | 3123db7726279a70a735141c2a01e8498b492697eea8f69ba80dfa1ccc0f211e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.491-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d74d92c639b42f0240cd5d2f934c09f604baf0dd3e180e3d4c04a4c385549642 |
|
MD5 | 168f6336aed68e7a43cdf3cca8d4a94f |
|
BLAKE2b-256 | 68b5a74c90f39172fc32c2c9383e4c2962c0f73da663aa6829d7007f558262c1 |