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.11.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f4919f03316c185a044dc52d04d8c53f121ef40a58457f0112b516d12f17391 |
|
MD5 | 5f9550e0321b06f9ac56a6a626cc4a0f |
|
BLAKE2b-256 | 7ca69f1838d5b05f104dfbbecd4378c833c711ef6fda56e24c964a9d6919a854 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 20c940c8a457a903f99c59c17c36994cd5ce7fa63626742c9ff2f910067a5402 |
|
MD5 | ad342cbedb50a01d5d03de52165525e6 |
|
BLAKE2b-256 | 7ec86214c50a70d979012f4128c160fd49846efe8e585865eb55ea135155d42a |