The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
OpenAPI-Client-0.17
River stage one • 6 direct dependents • 6 total dependents
15 ++
/ OpenAPI::Client

NAME

OpenAPI::Client - A client for talking to an Open API powered server

DESCRIPTION

OpenAPI::Client can generating classes that can talk to an Open API server. This is done by generating a custom class, based on a Open API specification, with methods that transform parameters into a HTTP request.

The generated class will perform input validation, so invalid data won't be sent to the server.

Note that this implementation is currently EXPERIMENTAL, but unlikely to change! Feedback is appreciated.

SYNOPSIS

Open API specification

The specification given to "new" need to point to a valid OpenAPI document, in either JSON or YAML format. Example:

  ---
  swagger: 2.0
  host: api.example.com
  basePath: /api
  schemes: [ "http" ]
  paths:
    /foo:
      get:
        operationId: listPets
        parameters:
        - name: limit
          in: query
          type: integer
        responses:
          200: { ... }

host, basePath and the first item in schemes will be used to construct "base_url". This can be altered at any time, if you need to send data to a custom endpoint.

Client

The OpenAPI API specification will be used to generate a sub-class of OpenAPI::Client where the "operationId", inside of each path definition, is used to generate methods:

  use OpenAPI::Client;
  $client = OpenAPI::Client->new("file:///path/to/api.json");

  # Blocking
  $tx = $client->listPets;

  # Non-blocking
  $client = $client->listPets(sub { my ($client, $tx) = @_; });

  # With parameters
  $tx = $client->listPets({limit => 10});

See Mojo::Transaction for more information about what you can do with the $tx object, but you often just want something like this:

  # Check for errors
  die $tx->error->{message} if $tx->error;

  # Extract data from the JSON responses
  say $tx->res->json->{pets}[0]{name};

Check out "error" in Mojo::Transaction, "req" in Mojo::Transaction and "res" in Mojo::Transaction for some of the most used methods in that class.

Customization

If you want to request a different server than what is specified in the Open API document:

  $client->base_url->host("other.server.com");

ATTRIBUTES

base_url

  $base_url = $self->base_url;

Returns a Mojo::URL object with the base URL to the API. The default value comes from schemes, basePath and host in the Open API specification.

pre_processor

  $code = $self->pre_processor;
  $self = $self->pre_processor(sub { my ($headers, $req) = @_; ... });

Holds a code ref that can pre-process the request. The return values are passed on to "build_tx" in Mojo::UserAgent. Example:

  $self->pre_processor(sub {
    my ($headers, $req) = @_;
    return $headers, json => {whatever => 42};
  });

The code above will result in this:

  $self->ua->build_tx($http_method, $url, $headers, json => {whatever => 42});
                                          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

$headers is a hash-ref containing the request headers and $req is a hash-ref that can contain either the key "body" or "form". Note that additional parameters might be added to $req, though it is unlikely.

ua

  $ua = $self->ua;

Returns a Mojo::UserAgent object which is used to execute requests.

METHODS

call

  $tx = $self->call($operationId => @args);
  $self = $self->call($operationId => @args, sub { my ($self, $tx) = @_; });

Used to either call an $operationId that has an "invalid name", such as "list pets" instead of "listPets" or to call an $operationId that you are unsure is supported yet. If it is not, an exception will be thrown, matching text "No such operationId".

$operationId is the name of the resource defined in the OpenAPI specification.

The first element in @args can be a hash ref, where a key should match a named parameter in the OpenAPI specification.

$tx is a Mojo::Transaction object.

call_p

  $promise = $self->call_p($operationId => @args);
  $promise->then(sub { my ($self, $tx) = @_; });

As "call" above, but instead of returning a $tx, returns a Mojo::Promise of that $tx. Obviously, you should not give a callback.

new

  $client = OpenAPI::Client->new($specification, \%attributes);
  $client = OpenAPI::Client->new($specification, %attributes);

Returns an object of a generated class, with methods generated from the Open API specification located at $specification. See "schema" in JSON::Validator for valid versions of $specification.

Note that the class is cached by perl, so loading a new specification from the same URL will not generate a new class.

Extra %attributes:

validator

  $validator = $self->validator;
  $validator = $class->validator;

Returns a JSON::Validator::OpenAPI::Mojolicious object for a generated class. Not that this is a global variable, so changing the object will affect all instances.

COPYRIGHT AND LICENSE

Copyright (C) 2017, Jan Henning Thorsen

This program is free software, you can redistribute it and/or modify it under the terms of the Artistic License version 2.0.

AUTHORS

Jan Henning Thorsen - jhthorsen@cpan.org

Ed J - etj@cpan.org