User:DKinzler (WMF)/Client Software Guidelines/attic

Introduction edit

How to find APIs
Where to find documentation and specs
- common data types
- error formats
- paging
Scope and applicability
Who is the target audience
What happens if I'm not following the guidelines.
- breakage
- blocks

Norms for maintainers

MUST subscribt to mailing list (api-announce?)
MAY make code available for code search

Further Guidance edit

no-retry Clients MUST NOT automatically retry request after the following errors, even if they may be transient:

HTTP status 403 ("access denied"). See #MUST surface user blocks.

Deprecated APIs edit

deprecated-apis Client software MUST NOT be written to access APIs that are already documented to be deprecated. Existing software may continue to access deprecated APIs, but MUST surface the associated warnings to the developer.

current-apis Client software should be kept up to date with the current version of the API. For this purpose, the maintainers of the software should subscribe to the relevant communication channels [TBD], and implement tests that will warn them about their software using deprecated APIs (see #MUST surface warnings to maintainers).

Cross-Site Requests edit

TBD, see API:Cross-site_requests

Implement correct semantics of data types edit

Client software must take care to interpret data types and structures in the way documented in their specification [TBD: reference inventory of standard data types].

This is particularly important for data types prone to subtle misinterpretation, such as:

date/time (time zones, year zero, etc)
intervals (open vs closed, end value vs size)
lists and sets (significant vs insignifcant order)
maps (case sensitivity of keys)
language codes (IANA vs WMF)
very small or very large numbers (float precision)
text (character sets, unicode normal form)

proper parameter encoding edit

Clients must use the UTF-8 encoding when making HTTP requests. Similarly, the response body must be interpreted as UTF-8, unless the Content-Type header specifies a different characters set.

HTTP headers in the request and responses are ASCII only, see RFC 7230.

All parts of the request URL use UTF-8, with percent-encoding used to escape special characters when they occurr in parameter values [TBD: ref path parameters, query parameters].

The following characters MUST be escaped when they occurr in path parameters, since they hold special meaning per the URL spec:

the question mark (?) as %3F
the percent sign (%) as %25
the hash sign (#) as %23

In addition, the following characters must also be escaped, because they may carry meaning the the context of REST endpoint routing:

the slash sign (/) as %2F
the pipe characters (|) as %7C (MAYBE, for custom verbs?) [TBD]
the ampersand characters (&) as %26 (MAYBE, for consisteny?) [TBD]

The following characters SHOULD NOT be escaped:

the colon (:) [TBD]

EXAMPLE: [TBD: correct way to do this in MW, php, python, JS]

NOTE: the set of characters that must be escaped in query parameter values and secment ID is slightly different! [TBD]

query parameters
path parameters...

minimize the number of requests edit

Client code should be designed to minimize the number of requests it sends to the server. The simplest way to achieve this is to avoid requesting information that is not actually needed. Beyond that, some APIs may support features that allow the number of requests to be reduced, such as:

Batch requests [TBD: reference the corresponding API design guide].
Property expansion [TBD: reference the corresponding API design guide].
Use streaming[TBD] instead of polling when possible.

Another way to reduce the number of requests is to avoid unneccessary redirects by ensuring that the request URL is normalized as much as possible. In particular:

Do not include trailing slashes or double slashes in the URL
Use the canonical form of resource identifiers in the URL

When available, clients should also make use of HTTP features that may reduce the number of requests, such as keep-alive and pipelining.

NOTE: Strategies to reduce the number of requests can be add odds with the goal of minimizing the amount of data transferred. The goal should be to keep both at a minimum, rather than to optimize one at the expense of the other. See #SHOULD minimize the amount of data transferred.

NOTE: Clients that cause an excessive number of requests may be rate limited or even blocked completely.

minimize the amount of data transferred edit

Client code should be designed to minimize the amount of data requested from the server. The simplest way to achieve this is to avoid requesting information that is not actually needed. Beyond that, some APIs may support features that allow the amount of data to be reduced, such as:

filtering of collections [TBD: reference the respective API design guide]
filtering of fields [TBD: reference the respective API design guide]

Furthermore, some features should be avoided in order to reduce the amount of traffic:

Property expansion, when not needed [TBD: reference the respective API design guide]

Clients should also make use of HTTP features that may reduce the amount of traffic, such as transparent compression.

NOTE: Strategies to reduce the amount of data can be add odds with the goal of minimizing the number of requests. The goal should be to keep both at a minimum, rather than to optimize one at the expense of the other. See #SHOULD minimize the number of requests.

NOTE: Clients that cause an excessive ammount of traffic may be rate limited or even blocked completely.

use on officially supported client library edit

TODO: Adjust MediaWiki's action API client to set X-Api-User-Agent (optionally include Gadget!) and follow retry and error handling rules. It currently doesn't implement any of this. TBD: Ticket.

TODO: Adjust the action API client in the node service template to set a User-Agent (optionally include Gadget!) and follow retry and error handling rules. It currently doesn't implement any of this. TBD: Ticket.

TODO: Adjust pywikibot's action API client to set a good User-Agent (maybe including the user name?) and follow retry and error handling rules. Retry defaults to 5 seconds min with exponential back-off, 15 retries or 120 sec max (which is retries). Retry-after is honored. TBD: Ticket.

TBD...

SHOULD follow redirects edit

...unless...
use correct semantics for 301, 302, 303, and 308, etc

MUST comply with robots.txt when scraping [??] edit

[do we need this here? robots.txt isn't really about APIs...]

SHOULD support compression edit

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding

https://developer.mozilla.org/en-US/docs/Web/HTTP/Compression#end-to-end_compression

MUST follow HTTP standards edit

Clients that interact with you APIs must follow the relevant HTTP standards, most importantly RFC 9110. This can for the most part be achieved by using a good HTTP client library.

More resources:

https://developer.mozilla.org/en-US/docs/Web/HTTP/Resources_and_specifications

SHOULD be designed to be robust against changes and failures edit

Clients could should follow the Robustness Principle: "be conservative in what you do, be liberal in what you accept from others". In practice, this means that failures of the network and of the server should be handled gracefully, and assumptions about the behavior of the server should be kept to a minimum.

[TBD: reference doc about what changes to the response body structure are considerd non-breaking (adding fields, etc - check wikidata stable interface policy)]

User:DKinzler (WMF)/Client Software Guidelines/attic

Contents