From c3f3d7ec71058f174ddb91fa62113e9ec31a9575 Mon Sep 17 00:00:00 2001 From: "Rene V. Vergara" Date: Sat, 23 Dec 2023 22:28:29 -0500 Subject: [PATCH] api-srvr: README update --- README.md | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2976902..3610b42 100644 --- a/README.md +++ b/README.md @@ -10,14 +10,39 @@ The template is functional and you can test it using HTTPie, curl or Postman. ### Start the API server +``` npm run dev +> api_srvr@1.0.0 dev +> nodemon ./src/apisrvr.ts -HTTPie +[nodemon] 3.0.2 +[nodemon] to restart at any time, enter `rs` +[nodemon] watching path(s): *.* +[nodemon] watching extensions: ts,json +[nodemon] starting `ts-node ./src/apisrvr.ts` +Basic API Server listening on Port:3000 +TypeScript Version +Press Ctrl-C to exit -http localhost:3000/ => returns "Main page loaded" -http localhost:3000/data => returns +``` + +### Test with HTTPie + +Using another terminal, run the following wommand ... +$> http localhost:3000/ +HTTP/1.1 200 OK +Connection: keep-alive +Content-Length: 16 +Content-Type: text/html; charset=utf-8 +Date: Sun, 24 Dec 2023 03:23:55 GMT +ETag: W/"10-bZZA7c+e/eSluV2PjdNck3t/8tA" +Keep-Alive: timeout=5 +X-Powered-By: Express +Main page loaded + +$> ...