|Did you know ...||Search Documentation:|
|Pack openapi -- README.md|
There are two options to support OpenAPI:
This library implements the first option. Future versions may reuse a lot of the infrastructure to implement the second option.
library(openapi) implements the following components:
In addition, there is a script
swi-openapi that wraps the above
library to create the skeleton server and client, including PlDoc
comments for the operations.
First of all, obtain a Swagger file using Swagger version 3.0. Now, to generate a server, do
swi-openapi --server=server.pl spec.yaml
This creates a Prolog file
server.pl with documented predicate
skeletons that must be filled by you. We advice to write the actual
implementation of the server in a separate module such that the
implementation you have to add to this file is short. This makes
upgrading and deploying multiple versions of the server API much easier.
There are additional options:
server.pl. For more complicated projects you probably want something more advanced. This quickly gets you started though.
To generate a client run
swi-openapi --client=client.pl spec.yaml
This creates documented predicates that call the API. The server address
is extracted from
spec.yaml. Probably the best way to use this is to
client.pl into your project using include/1.
operationId from the Swagger file is used as the name of the
predicate, both for the server and client. The arguments are extracted
parameters specification in the Swagger file. Required
arguments use a normal Prolog argument. Optional parameters are passed
using a Prolog option list. If there is a return value, this is
positioned after the required argument and before the option list. On
the client side, normal responses are returned as data. The
is mapped to an exception of the form
Data),_), where Code is the HTTP status code and Data the data
returned by the server. If an operation only defines code 204 (no
content) and a default, the parameter is missing in the client and the
predicate succeeds if the server replies 204 or throws an exception as
The implementation skeleton for each server operation has a variable Response. The implementation must succeed and bind Response to one of the terms below.
Currently, Data must be a term suitable for json_write_dict/3. Future versions will support a other replies and a hook to extend the reply types.
examples directory for two examples from the Swagger site.
SWI-Prolog 7.7.11 for basic operation. This version has a bug in the YAML parser and lacks an extension to http_parameters/2 that supports more precise HTTP error reports.