paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-23 04:52:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Clarify how to test API endpoints.

Browse Source
This commit is contained in:
Tim Abbott
2020-03-20 14:08:18 -07:00
parent 8c1244d0b4
commit fcd0a116b4
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/documentation/api.md
View File

@@ -250,9 +250,12 @@ above.
1. Add the markdown file to the index in `templates/zerver/help/include/rest-endpoints.md`.
1. Test your endpoint, pretending to be a new user in a hurry. You
should make sure that copy-pasting the code in your examples works,
and post an example of the output in the pull request.
1. Test your endpoint, pretending to be a new user in a hurry, by
visiting it via the links on `http://localhost:9991/api` (the API
docs are rendered from the markdown source files on page load, so
just reload to see an updated version as you edit). You should
make sure that copy-pasting the code in your examples works, and
post an example of the output in the pull request.
[javascript-examples]: https://github.com/zulip/zulip-js/tree/master/examples