.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mojolicious::Plugin::OpenAPI::Guides::Swagger2 3pm"
.TH Mojolicious::Plugin::OpenAPI::Guides::Swagger2 3pm "2023-02-21" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Mojolicious::Plugin::OpenAPI::Guides::Swagger2 \- Swagger2 back compat guide
.SH "OVERVIEW"
.IX Header "OVERVIEW"
This guide is useful if your application is already using
Mojolicious::Plugin::Swagger2.
.PP
The old plugin used to pass on \f(CW$args\fR and \f(CW$cb\fR to the action. This can be
emulated using an around_action hook. The
\&\*(L"\s-1SYNOPSIS\*(R"\s0 below contains example code that you can use to make your old
controllers and actions work with Mojolicious::Plugin::OpenAPI.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  package MyApp;
\&  use Mojo::Base "Mojolicious";
\&
\&  sub startup {
\&    my $self = shift;
\&
\&    # Load your specification
\&    $self\->plugin("OpenAPI" => {url => $app\->home\->rel_file("myapi.json")});
\&
\&    $self\->hook(around_action => sub {
\&      my ($next, $c, $action, $last) = @_;
\&
\&      # Do not call the action with ($args, $cb) unless it is an
\&      # OpenAPI endpoint.
\&      return $next\->() unless $last;
\&      return $next\->() unless $c\->openapi\->spec;
\&
\&      # Render error document unless the input is valid
\&      return unless $c\->openapi\->valid_input;
\&
\&      my $cb = sub {
\&        my ($c, $data, $code) = @_;
\&        $c\->render(openapi => $data, status => $code);
\&      };
\&
\&      # Call the action with ($args, $cb)
\&      # NOTE! $c\->validation\->output will be removed in the future
\&      return $c\->$action($c\->validation\->output, $cb);
\&    });
\&  }
.Ve
.SH "MOVING FORWARD"
.IX Header "MOVING FORWARD"
Note that the \f(CW\*(C`around_action\*(C'\fR hook above does not prevent you from writing new
actions using the standard Mojolicious::Plugin::OpenAPI \s-1API.\s0 In the new actions,
you can simply drop using \f(CW$args\fR and \f(CW$cb\fR and it will work as expected as
well.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
<https://github.com/jhthorsen/mojolicious\-plugin\-openapi/blob/master/t/swagger2.t>
.PP
Mojolicious::Plugin::OpenAPI.