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.520.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | eea8047dfa3c786c084579f6bf1222dbdf9e961adb1f57519b741944427abdce |
|
MD5 | 175837acc96d8aadfc9d8e2821f4d9da |
|
BLAKE2b-256 | 5bd9d997047e8c704b8c8cec5e05f1d7a826a7553c7c7f8b970ee7cd4407fdb6 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.520-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf08245afd6df153c0ddea9c0d5b9a2d5ebfa842db639aa07fb7aa7a3408e760 |
|
MD5 | 28a08f94d50478435d155b91a493f7f7 |
|
BLAKE2b-256 | aa19f4cd097fd865cc1549acb73f4ddf4eb9d2b2b363a60e8a77f2ae27bf58ad |