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.440.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa3f5fd661424cc0cd1d50f465dc1497a963a83bb35ab8700b18128574f6cfcc |
|
MD5 | 77835e1a187f35d5718441a23f98719a |
|
BLAKE2b-256 | 66fd0bccd324b730eeb1071d1d44cc4e125ec9cfcd9fd106b156c2b7e5c6a392 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.440-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b876bd2a0a6692af84a67aa3ea533affdd3f0d7094f8d0cf181885adc6a87908 |
|
MD5 | d6a31d69a4838c401d680798023a6b7a |
|
BLAKE2b-256 | d77a5554d4c9ee8f543929901a554348cbae22416551b6650661b2fe3fc4c86a |