Mercurial > hg
comparison mercurial/configitems.py @ 37046:1cfef5693203
wireproto: support /api/* URL space for exposing APIs
I will soon be introducing a new version of the HTTP wire protocol.
One of the things I want to change with it is the URL routing.
I want to rely on URL paths to define endpoints rather than the
"cmd" query string argument. That should be pretty straightforward.
I was thinking about what URL space to reserve for the new protocol.
We /could/ put everything at a top-level path. e.g.
/wireproto/* or /http-v2-wireproto/*. However, these constrain us
a bit because they assume there will only be 1 API: version 2 of
the HTTP wire protocol. I think there is room to grow multiple
APIs. For example, there may someday be a proper JSON API to query
or even manipulate the repository. And I don't think we should have
to create a new top-level URL space for each API nor should we
attempt to shoehorn each future API into the same shared URL space:
that would just be too chaotic.
This commits reserves the /api/* URL space for all our future API
needs. Essentially, all requests to /api/* get routed to a new WSGI
handler. By default, it 404's the entire URL space unless the
"api server" feature is enabled. When enabled, requests to "/api"
list available APIs. URLs of the form /api/<name>/* are reserved for
a particular named API. Behavior within each API is left up to that
API. So, we can grow new APIs easily without worrying about URL
space conflicts.
APIs can be registered by adding entries to a global dict. This allows
extensions to provide their own APIs should they choose to do so.
This is probably a premature feature. But IMO the code is easier
to read if we're not dealing with API-specific behavior like config
option querying inline.
To prove it works, we implement a very basic API for version 2
of the HTTP wire protocol. It does nothing of value except
facilitate testing of the /api/* URL space.
We currently emit plain text responses for all /api/* endpoints.
There's definitely room to look at Accept and other request headers
to vary the response format. But we have to start somewhere.
Differential Revision: https://phab.mercurial-scm.org/D2834
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Tue, 13 Mar 2018 16:53:21 -0700 |
parents | 5890e5872f36 |
children | 8c3c47362934 |
comparison
equal
deleted
inserted
replaced
37045:a708e1e4d7a8 | 37046:1cfef5693203 |
---|---|
578 default=False, | 578 default=False, |
579 ) | 579 ) |
580 coreconfigitem('experimental', 'sshpeer.advertise-v2', | 580 coreconfigitem('experimental', 'sshpeer.advertise-v2', |
581 default=False, | 581 default=False, |
582 ) | 582 ) |
583 coreconfigitem('experimental', 'web.apiserver', | |
584 default=False, | |
585 ) | |
586 coreconfigitem('experimental', 'web.api.http-v2', | |
587 default=False, | |
588 ) | |
583 coreconfigitem('experimental', 'xdiff', | 589 coreconfigitem('experimental', 'xdiff', |
584 default=False, | 590 default=False, |
585 ) | 591 ) |
586 coreconfigitem('extensions', '.*', | 592 coreconfigitem('extensions', '.*', |
587 default=None, | 593 default=None, |