.\" 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::Command::openapi 3pm"
.TH Mojolicious::Command::openapi 3pm "2022-10-30" "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::Command::openapi \- Perform Open API requests
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  Usage: APPLICATION openapi SPECIFICATION OPERATION "{ARGUMENTS}" [SELECTOR|JSON\-POINTER]
\&
\&    # Fetch /api from myapp.pl and list available operationId
\&    ./myapp.pl openapi /api
\&
\&    # Dump the whole specification or for an operationId
\&    ./myapp.pl openapi /api \-I
\&    ./myapp.pl openapi /api \-I addPet
\&
\&    # Run an operation against a local application
\&    ./myapp.pl openapi /api listPets /pets/0
\&
\&    # Run an operation against a local application, with body parameter
\&    ./myapp.pl openapi /api addPet \-c \*(Aq{"name":"pluto"}\*(Aq
\&    echo \*(Aq{"name":"pluto"} | ./myapp.pl openapi /api addPet
\&
\&    # Run an operation with parameters
\&    mojo openapi spec.json listPets \-p limit=10 \-p type=dog
\&
\&    # Run against local or online specifications
\&    mojo openapi /path/to/spec.json listPets
\&    mojo openapi http://service.example.com/api.json listPets
\&
\&  Options:
\&    \-h, \-\-help                           Show this summary of available options
\&    \-c, \-\-content <content>              JSON content, with body parameter data
\&    \-i, \-\-inactivity\-timeout <seconds>   Inactivity timeout, defaults to the
\&                                         value of MOJO_INACTIVITY_TIMEOUT or 20
\&    \-I, \-\-information [operationId]      Dump the specification about a given
\&                                         operationId or the whole spec.
\&                                         YAML::XS is preferred if available.
\&    \-o, \-\-connect\-timeout <seconds>      Connect timeout, defaults to the value
\&                                         of MOJO_CONNECT_TIMEOUT or 10
\&    \-p, \-\-parameter <name=value>         Specify multiple header, path, or
\&                                         query parameter
\&    \-S, \-\-response\-size <size>           Maximum response size in bytes,
\&                                         defaults to 2147483648 (2GB)
\&    \-v, \-\-verbose                        Print request and response headers to
\&                                         STDERR
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Mojolicious::Command::openapi is a command line interface for
OpenAPI::Client.
.PP
Not that this implementation is currently \s-1EXPERIMENTAL\s0! Feedback is
appreciated.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "description"
.IX Subsection "description"
.Vb 1
\&  $str = $command\->description;
.Ve
.SS "usage"
.IX Subsection "usage"
.Vb 1
\&  $str = $command\->usage;
.Ve
.SH "METHODS"
.IX Header "METHODS"
.SS "run"
.IX Subsection "run"
.Vb 1
\&  $command\->run(@ARGV);
.Ve
.PP
Run this command.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
OpenAPI::Client.