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 Q3 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

Copyright (C) 2024 by Bartosz Jarzyna

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