NAME

Whelk - A friendly API framework based on Kelp

SYNOPSIS

$ kelp-generator --type=whelk MyResource
$ plackup

DESCRIPTION

Whelk is an API framework which helps you create correct, fast, self-documenting APIs. It's easy to learn, fun to work with and extremely customizable. It can be run either standalone as a Plack application, or inside a Kelp application as a module.

Whelk is integrated with OpenAPI/Swagger and automatically generates a document according to spec v3 rules. All the data for the document is taken directly from your endpoint validation rules, which ensures only minimal effort is needed to generate a documentation for your project. The resulting documentation can be beautifully visualized using OpenAPI tools like Swagger UI.

Whelk is currently in beta. It's not production ready and some changes in interface are possible. Beta phase will end no later than early Q4 2024 with version 1.00.

To get started, take a look at Whelk::Manual.

ACKNOWLEDGEMENTS

This module was inspired by Raisin.

Thank you to Stefan Geneshky who created Kelp.

AUTHOR

Bartosz Jarzyna <bbrtj.pro@gmail.com>

Consider supporting my effort: https://bbrtj.eu/support

COPYRIGHT AND LICENSE

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

To install Whelk, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Whelk

CPAN shell

perl -MCPAN -e shell
install Whelk

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)