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.475.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11cc9922f17b51f82cc0c5d78edcc4cf378355c0b20c84afe7ba3f6d381751bf |
|
MD5 | f7c6e418829ad2bd2e5e9147cba4db6f |
|
BLAKE2b-256 | 22810ca6b983aa7b230f3d40aba1eaa86df94aad73acc31aed0634ca4aed8e41 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.475-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 06afdd231e35b0353c7fe1fb54f107e9151a567ff50d0278e001227400eb9ef2 |
|
MD5 | 22aae8e1d1e1449be0dbe05d3c6e8c5b |
|
BLAKE2b-256 | 6f624a7c171704cc5cff329f412c99007adf25e785f25de7fd63d822de2522c7 |