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.431.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5cb906aaca7c26fc9f2af5a47fc6c6deaf7116ca1174afd387e5bccaa0b2eddf |
|
MD5 | 944ad80606bff9809fae9999b7342444 |
|
BLAKE2b-256 | 0a0ebe59a20f3f2751ca1770f5bd917c3a7486eb72c7a9c7107d559493fc1f98 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.431-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 06a90f6405c6c161bb1286596bdf3cd4de5a8d3b169716ced67231d0e84b6763 |
|
MD5 | 3c68814aba968c06013bccdf28949f1f |
|
BLAKE2b-256 | 459cd44131e6c4f5807b63fd24ceaf6a9535df679dcf21f5152e2ff349c291b8 |