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

;web: tweak JSON PUT doc

Browse Source
This commit is contained in:
Simon Michael 2020-05-21 10:48:04 -07:00
parent e207b089c5
commit 20c480a914
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -203,9 +203,12 @@ sure that both machine clocks are roughly in step.)
# JSON API # JSON API
In addition to the web UI, hledger-web provides some API routes that In addition to the web UI, hledger-web also serves a JSON API that can be
serve JSON in response to GET requests. (And when started with `--serve-api`, used to get data or add new transactions.
it provides only these routes.): If you only want the JSON API, run with the `--serve-api` flag.
You can GET JSON data from these routes:
``` ```
/accountnames /accountnames
/transactions /transactions
@ -215,13 +218,13 @@ it provides only these routes.):
/accounttransactions/#AccountName /accounttransactions/#AccountName
``` ```
Also, you can append a new transaction to the journal by sending a PUT request to `/add` (hledger-web only). And you can add a new transaction to the journal with a PUT request to `/add`,
As with the web UI's add form, hledger-web must be started with the `add` capability for this (enabled by default). if hledger-web was started with the `add` capability (enabled by default).
Note the payload must be the full exact JSON representation of a hledger transaction The payload must be the full, exact JSON representation of a hledger transaction
(partial JSON won't do). (partial data won't do).
You can download some sample JSON from `/transactions` or `/accounttransactions`, You can get sample JSON from `/transactions` or `/accounttransactions`,
or export it using hledger-lib's `writeJsonFile` helper (there's also `readJsonFile` for testing): or you can export it with hledger-lib's `writeJsonFile` helper, like so:
```shell ```shell
$ make ghci-web $ make ghci-web
@ -339,9 +342,6 @@ And here's how to test adding it with curl. This should add a new entry to your
$ curl http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' --data-binary @txn.json $ curl http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' --data-binary @txn.json
``` ```
By default, both the server-side HTML UI and the JSON API are served.
Running with `--serve-api` disables the former, useful if you only want to serve the API.
# ENVIRONMENT # ENVIRONMENT
_LEDGER_FILE_ _LEDGER_FILE_