api-srvr: README update
This commit is contained in:
parent
83e371a164
commit
69e6375f38
1 changed files with 20 additions and 2 deletions
22
README.md
22
README.md
|
@ -1,5 +1,23 @@
|
||||||
# Basic API server (Node.js + TypeScript)
|
# Basic API server (Node.js + Express.js and TypeScript)
|
||||||
|
|
||||||
## Abstract
|
## Abstract
|
||||||
|
|
||||||
A basic functional template for creating an API server using Node.js and TypeScript.
|
A basic functional template for creating an API server using Node.js + Express.js and TypeScript.
|
||||||
|
|
||||||
|
## Test
|
||||||
|
|
||||||
|
The template is functional and you can test it using HTTPie, curl or Postman.
|
||||||
|
|
||||||
|
### Start the API server
|
||||||
|
|
||||||
|
npm run dev
|
||||||
|
|
||||||
|
|
||||||
|
HTTPie
|
||||||
|
|
||||||
|
http localhost:3000/ => returns "Main page loaded"
|
||||||
|
http localhost:3000/data => returns
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
...
|
||||||
|
|
Loading…
Reference in a new issue