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.583.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5c9f76d5bb67ac846e86ac0e1e13162d6bd453a5f7e63c4aeb095e3c790d225f |
|
MD5 | 6e812dee047d0f9de65013ec00ee06a7 |
|
BLAKE2b-256 | ef4a2b51d062465cb55bea88520e2e5f44cde6179688e4640d08dbe6c48404d4 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.583-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0e3e67a7c27a341f02f874db9453213c92261f57cda3441559716723d651b0b |
|
MD5 | 2af3875e0ee2f9f4f23373e05dec0208 |
|
BLAKE2b-256 | b413efba7d0eb4264e86206c12680433a07fd6a7de55c71a408c3a8e29394182 |