| line |
stmt |
bran |
cond |
sub |
pod |
time |
code |
|
1
|
|
|
|
|
|
|
package Whelk; |
|
2
|
|
|
|
|
|
|
$Whelk::VERSION = '1.04'; |
|
3
|
19
|
|
|
19
|
|
4457559
|
use Kelp::Base 'Kelp'; |
|
|
19
|
|
|
|
|
43
|
|
|
|
19
|
|
|
|
|
175
|
|
|
4
|
|
|
|
|
|
|
|
|
5
|
|
|
|
|
|
|
attr 'config_module' => '+Whelk::Config'; |
|
6
|
|
|
|
|
|
|
|
|
7
|
|
|
|
78
|
1
|
|
sub before_dispatch { } |
|
8
|
|
|
|
|
|
|
|
|
9
|
|
|
|
|
|
|
sub build |
|
10
|
|
|
|
|
|
|
{ |
|
11
|
19
|
|
|
19
|
1
|
5315794
|
my ($self) = @_; |
|
12
|
|
|
|
|
|
|
|
|
13
|
19
|
|
|
|
|
83
|
$self->whelk->finalize; |
|
14
|
|
|
|
|
|
|
} |
|
15
|
|
|
|
|
|
|
|
|
16
|
|
|
|
|
|
|
1; |
|
17
|
|
|
|
|
|
|
|
|
18
|
|
|
|
|
|
|
__END__ |
|
19
|
|
|
|
|
|
|
|
|
20
|
|
|
|
|
|
|
=pod |
|
21
|
|
|
|
|
|
|
|
|
22
|
|
|
|
|
|
|
=head1 NAME |
|
23
|
|
|
|
|
|
|
|
|
24
|
|
|
|
|
|
|
Whelk - A fortified API framework based on Kelp |
|
25
|
|
|
|
|
|
|
|
|
26
|
|
|
|
|
|
|
=head1 SYNOPSIS |
|
27
|
|
|
|
|
|
|
|
|
28
|
|
|
|
|
|
|
$ kelp-generator --type=whelk MyResource |
|
29
|
|
|
|
|
|
|
$ plackup |
|
30
|
|
|
|
|
|
|
|
|
31
|
|
|
|
|
|
|
=head1 DESCRIPTION |
|
32
|
|
|
|
|
|
|
|
|
33
|
|
|
|
|
|
|
=begin html |
|
34
|
|
|
|
|
|
|
|
|
35
|
|
|
|
|
|
|
<p style="text-align: center"><img width="80%" src="https://raw.githubusercontent.com/Kelp-framework/Art/master/whelk/logo_wide.png" alt="logo"></p> |
|
36
|
|
|
|
|
|
|
<p style="text-align: center"><b>A fortified web API framework</b></p> |
|
37
|
|
|
|
|
|
|
|
|
38
|
|
|
|
|
|
|
=end html |
|
39
|
|
|
|
|
|
|
|
|
40
|
|
|
|
|
|
|
Whelk is an API framework which helps you create correct, fast, |
|
41
|
|
|
|
|
|
|
self-documenting APIs. It's easy to learn, fun to work with and extremely |
|
42
|
|
|
|
|
|
|
customizable. It can be run either standalone as a L<Plack> application, or |
|
43
|
|
|
|
|
|
|
inside a L<Kelp> application as a module. |
|
44
|
|
|
|
|
|
|
|
|
45
|
|
|
|
|
|
|
Whelk is integrated with OpenAPI/Swagger and automatically generates a document |
|
46
|
|
|
|
|
|
|
according to spec v3 rules. All the data for the document is taken directly |
|
47
|
|
|
|
|
|
|
from your endpoint validation rules, which ensures only minimal effort is |
|
48
|
|
|
|
|
|
|
needed to generate a documentation for your project. The resulting |
|
49
|
|
|
|
|
|
|
documentation can be beautifully visualized using OpenAPI tools like Swagger |
|
50
|
|
|
|
|
|
|
UI. |
|
51
|
|
|
|
|
|
|
|
|
52
|
|
|
|
|
|
|
To get started, take a look at L<Whelk::Manual>. |
|
53
|
|
|
|
|
|
|
|
|
54
|
|
|
|
|
|
|
=head1 ACKNOWLEDGEMENTS |
|
55
|
|
|
|
|
|
|
|
|
56
|
|
|
|
|
|
|
This module was inspired by L<Raisin>. |
|
57
|
|
|
|
|
|
|
|
|
58
|
|
|
|
|
|
|
Thank you to Stefan Geneshky who created L<Kelp>. |
|
59
|
|
|
|
|
|
|
|
|
60
|
|
|
|
|
|
|
=head1 AUTHOR |
|
61
|
|
|
|
|
|
|
|
|
62
|
|
|
|
|
|
|
Bartosz Jarzyna E<lt>bbrtj.pro@gmail.comE<gt> |
|
63
|
|
|
|
|
|
|
|
|
64
|
|
|
|
|
|
|
Consider supporting my effort: L<https://bbrtj.eu/support> |
|
65
|
|
|
|
|
|
|
|
|
66
|
|
|
|
|
|
|
=head1 COPYRIGHT AND LICENSE |
|
67
|
|
|
|
|
|
|
|
|
68
|
|
|
|
|
|
|
Copyright (C) 2024 by Bartosz Jarzyna |
|
69
|
|
|
|
|
|
|
|
|
70
|
|
|
|
|
|
|
This library is free software; you can redistribute it and/or modify |
|
71
|
|
|
|
|
|
|
it under the same terms as Perl itself. |
|
72
|
|
|
|
|
|
|
|