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.127.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 95ed6c55c32e4c5bbb602cf1d9c13fcdfff2a3efd6e053854e77e5677dcef23e |
|
MD5 | 886d1fe7c9b2795980a96a88d1ba0615 |
|
BLAKE2b-256 | 60cdf69d96a2ca154d9ce8d0b0e97181e2cf3eb187db74fbfe0c6942af23f082 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.127-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5de4056b1f1271b8c0ee1479e7ac1f584dc708cdd0fe636e98520049f3e113e2 |
|
MD5 | f3fd43c91e9b29b8ee6a79d562c645f9 |
|
BLAKE2b-256 | 0b4fe1770db367ca602cf0036d2122cf4c00ad68d4ddd19f7f7739f4d46dd0a9 |