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.221.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc57b48e1007e04f47bcce99282bc8b8bcef72f6696b562ae3260b0139ff01ba |
|
MD5 | 3388671ac9deef998a9143df278c8625 |
|
BLAKE2b-256 | cb9daadd8fd15d21f8a91131476b33f9bc85179dce3a4a128fdc0c1bd56bf400 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.221-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 17091b40509afce1dfa7e7b5976c20e886e6d6f1742e1ae20fca5fe4e39601b2 |
|
MD5 | f3be3f81fd0fe46d41ed0ed94706bc7a |
|
BLAKE2b-256 | 9c55f5dde48e6880d387525f50d20160e7b4907c7cedfa7594d2496efc3fc3ed |