Module RestoSource

Resto

Resto is a library for defining, serving, and querying a REST directory of RPC services.

Overview of Resto

Resto is a library for describing *services*. A service is the entry-point in an API: a URI/URL with some path parameters (some of the slash-separated segments are actually decoded as parameters), some additional query parameters (the part that looks like ?utm_parameter=from_email in the links of marketing emails) and other attributes depending on the method of the service.

For example, you can use Resto to describe the directory of services that, as a whole, forms the API for a web-service. You can then use one of the other resto packages to implement a server that answers requests made to this API. Alternatively, you can use one of the other resto packages to make your program query such an API.

Intended use of Resto

The intended use of Resto is as follows:

• Define arguments, paths, query fields, and queries as required by the API you describe.
• Define services using the previously defined arguments, paths, query fields and queries.
• Use Resto_directory to register those services.

If you are writing a server, you can then:

• Use Resto_cohttp_server.Server to spin up a server that answers requests to these services.

Alternatively, if you are writing a client, you can then:

• Use Resto_cohttp_client.Client to make requests to these services.

And of course you can do both if you are writing both the server and the client.