slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

api: doc: more detailed api description

Browse Source
This commit is contained in:
Simon Michael 2018-02-16 11:09:07 -08:00
parent 8a0d2d7276
commit e6e8e3420b
1 changed files with 19 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
hledger-api/hledger-api.m4.md
View File

@ -31,12 +31,26 @@ For more about this see hledger(1), hledger_journal(5) etc.
The server listens on IP address 127.0.0.1, accessible only to local requests, by default. The server listens on IP address 127.0.0.1, accessible only to local requests, by default.
You can change this with `--host`, eg `--host 0.0.0.0` to listen on all addresses. You can change this with `--host`, eg `--host 0.0.0.0` to listen on all addresses.
Note there is no other access control, so you will need to hide Note there is no other access control, and hledger-api allows file browsing,
hledger-api behind an authenticating proxy if you want to restrict access. so on shared machines you will certainly need to put it behind an authenticating proxy to restrict access.
You can change the TCP port (default: 8001) with `-p PORT`.
If invoked as `hledger-api --swagger`, instead of starting a server You can change the TCP port it listens on (default: 8001) with `-p PORT`.
the API docs will be printed in Swagger 2.0 format.
API methods look like:
```
/api/v1/accountnames
/api/v1/transactions
/api/v1/prices
/api/v1/commodities
/api/v1/accounts
/api/v1/accounts/ACCTNAME
```
See `/api/swagger.json` for a full list in Swagger 2.0 format.
(Or you can run `hledger-api --swagger` to print this in the console.)
hledger-api also serves files, from the current directory by default,
and the `/` path will also show a directory listing.
This is convenient for serving client-side web code, in addition to the server-side api.
# OPTIONS # OPTIONS