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.883.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 401a0206992b53504fa59172cd00ef782485ff8a367caac750494964efa7974b |
|
MD5 | 4a14948ee3cae20e8586cdfad6b5f871 |
|
BLAKE2b-256 | fd96b792b4ab16c41cb23f0545e92ebada55deaf028ea0ae52abcdde798755d1 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.883-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d26a8974e7196e67718e4e5ae1a07deb04d4521819023cffeb0ce2adfd0e0708 |
|
MD5 | 4d1ad51cca10dc1c389fc59c1f4fea88 |
|
BLAKE2b-256 | 9a5216f678f5f65e39280cc5b64a0e59157e7870c7c6f02b53c85174e5e79762 |