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.746.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d3168df114050bdbcf7771a52918805d8b3a108183e6a8a50daf55490ddeda3a |
|
MD5 | b29053f9a32bff75680f9d6bee6a4191 |
|
BLAKE2b-256 | 010144affdbe77c2a1c1fa5f46db3047e5d59c7cd1b02af98ff97c18f3bb5ed0 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.746-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 237df16d5310a7e11353121e5244e09317f789aac78bf6b32a5b710e23b1a823 |
|
MD5 | b76d128149ae57361f6adb4f3f66dc63 |
|
BLAKE2b-256 | d93c01e6e0015f1e459011224eb5946759fba63a1044255a526b8bdb3fc1bd8d |