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.307.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8ed9a53435344624d2e207952db305d4d2b6ce8d45a9e7c670bb269f1525b817 |
|
MD5 | 9245e4afe0d3d8d36c501471a3036521 |
|
BLAKE2b-256 | 95dff6eec676437c28fad2844057f3d83aa3324204008d596e886160b3f3a5a0 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.307-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c803f02abeaaaa5574db4581baf47dcfdb609a6540d44cf23d6091764123d97 |
|
MD5 | c11e9718e970293b66e65a7d0526a758 |
|
BLAKE2b-256 | 482d715595a07732924153a1de34f3984c6ddefc63cd4aad2468c7df077a1f5e |