From fcd0a116b4ebb8cbfe282d768558c555c53257ec Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Fri, 20 Mar 2020 14:08:18 -0700 Subject: [PATCH] docs: Clarify how to test API endpoints. --- docs/documentation/api.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/documentation/api.md b/docs/documentation/api.md index 42f4dca272..dd3a5123f2 100644 --- a/docs/documentation/api.md +++ b/docs/documentation/api.md @@ -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