As I am not considering myself as a developer, I always pay a lot of attention of what is implicit in the given explanations of a post dedicated for instance on how build a Node API. Most of the posts that have read are stuffed with useful but implicit information. Here is the reason why I am making this quick digest of its, avoiding as far as I can plagiarism and adding 2 plus : a test strategy and a way to handle documentation with Apidoc.<\/p>\n
Be sure before you start, to ensure that you have npm and mongo installed. Just go in the console and type the following commands.<\/p>\n
$ npm -v<\/pre>\n$ mongo --version<\/pre>\n$ node -v<\/pre>\nIf Homebrew, Node or Mongo are not installed. Here the shortest procedure to install all requirements on a Mac. Very brief but you got the essentials, if you have already installed these tools, you can jump to the point 1.<\/b><\/p>\n\n- Install Postman: Check https:\/\/www.getpostman.com\/apps<\/li>\n
- Install Homebrew: Check https:\/\/brew.sh\/. Launch in the console:\n
$ \/usr\/bin\/ruby -e \"$(curl -k -fsSL https:\/\/raw.githubusercontent.com\/Homebrew\/install\/master\/install)\"<\/pre>\n<\/li>\n
- Install Node and NPM:\n
\r\n $ brew update\r\n $ brew doctor\r\n $ export PATH=\"\/usr\/local\/bin:$PATH\"\r\n $ brew install node\r\n<\/pre>\n Source: https:\/\/changelog.com\/posts\/install-node-js-with-homebrew-on-os-x<\/a>\n<\/li>\n- Install Newman globally:\n
\r\n $ npm install -g newman\r\n<\/pre>\n. Source: https:\/\/support.getpostman.com\/hc\/en-us\/articles\/115003703325-How-do-I-install-Newman-<\/a><\/li>\n- Install MongoDB:\n
\r\n$ brew update\r\n$ brew install mongodb\r\n<\/pre>\nAt the root of your computer, create the default directory*. <\/p>\n
\r\n $ mkdir -p \/data\/db\r\n<\/pre>\n* Run without specifying paths: If your system PATH variable includes the location of the mongod binary and if you use the default data directory (i.e., \/data\/db), simply enter mongod at the system prompt: mongod<\/code><\/i>.<\/p>\nSource: https:\/\/docs.mongodb.com\/manual\/tutorial\/install-mongodb-on-os-x\/<\/a><\/li>\n<\/ul>\n1. SETTINGS<\/h4>\n
First of all, the content that the API decide on a semantic point of view what you are going to use in terms of wording both for the MVC of your Node application and the database for mongodb. In my case, I am working with countries, so I may need to use for the MVC something like country!<\/p>\n
As you will a create a countries dedicated to countries, be sure to thing of using country<\/code> or countries<\/code> as “prefix” as much as possible and so On<\/b><\/p>\nHere is future name of for my coming controller, model, route: country.controller.js<\/code>, country.model.js<\/code>, country.routes.js<\/code><\/p>\nHere the name for the database in mongodb: countries_light_app<\/b>
\nThe directory and appName: node-countries-light-app<\/b><\/p>\n2. CREATING A SIMPLE APP <\/h4>\n
To ensure that you are in the correct directory of the app<\/b> <\/p>\n$ pwd<\/pre>\n$ cd \/[path-in-your-environment]<\/pre>\n$ mkdir node-countries-light-app<\/pre>\n$ cd node-countries-light-app<\/pre>\nIn the application directory node-countries-light-app<\/code><\/b>
\n![\"Node,](\"https:\/\/flaven.fr\/wp-content\/uploads\/2018\/05\/001_node_api_testing_npm_init.jpg\")
<\/p>\nLaunch the installation with npm, by default this will load the content of package.json<\/b><\/p>\n$ npm install<\/pre>\nIn the console, go the directory where you want to create your app directory node-countries-light-app<\/code><\/b><\/p>\nYou will define the characteristics of your application and then you will get the famous package.json file with the basics information of your node application.<\/p>\n
\n- The value for the name:
node-countries-light-app<\/code><\/li>\n- The value for the description:
Yallah Yallah, Welcome to Country Light App. A prototype to play with Countries.<\/code><\/li>\n- The values for the keywords:
Node, Express, RestAPI, MongoDB, Mongoose, Countries<\/code><\/li>\n<\/ul>\nBe sure to be in your application directory node-countries-light-app<\/code> and type this command.<\/b><\/p>\n$ npm init<\/pre>\nAfter a simple step by step, you should get a package.json created with npm init like this one below:<\/b><\/p>\n\r\n{\r\n \"name\": \"countries-light-app\",\r\n \"version\": \"1.0.0\",\r\n \"description\": \"Yallah Yallah, Welcome to Country Light App. A prototype to play with Countries\",\r\n \"main\": \"server.js\",\r\n \"scripts\": {\r\n \"test\": \"echo \\\"Error: no test specified\\\" && exit 1\"\r\n },\r\n \"keywords\": [\r\n \"Node\",\r\n \"Express\",\r\n \"RestAPI\",\r\n \"MongoDB\",\r\n \"Mongoose\",\r\n \"Countries\"\r\n ],\r\n \"author\": \"bflaven\",\r\n \"license\": \"ISC\"\r\n}\r\n<\/pre>\nCreating the package.json<\/b>
\n![\"Node,](\"https:\/\/flaven.fr\/wp-content\/uploads\/2018\/05\/002_node_api_testing_npm_init_start.jpg\")
<\/p>\n
Creating the package.json<\/b>
\n![\"Node,](\"https:\/\/flaven.fr\/wp-content\/uploads\/2018\/05\/003_node_api_testing_npm_init_end.jpg\")
<\/p>\n
Install the Node elements that are required to make your application working<\/b><\/p>\n$ npm install express body-parser mongoose --save<\/pre>\nYour application directory node-countries-light-app<\/code> now has a package.json file and a node_modules folder and should look like this:<\/b><\/p>\n\r\nnode-countries-light-app\/\r\n|-- _node_modules\/\r\n |-- ... \r\n|-- package.json\r\n<\/pre>\nLaunching the install<\/b>
\n![\"Node,](\"https:\/\/flaven.fr\/wp-content\/uploads\/2018\/05\/004_node_api_testing_npm_install.jpg\")
<\/p>\n
Launching the install<\/b>
\n![\"Node,](\"https:\/\/flaven.fr\/wp-content\/uploads\/2018\/05\/005_node_api_testing_npm_install_end.jpg\")
<\/p>\n
Create the server file for your Node application<\/b><\/p>\n\r\n$ touch server.js\r\n<\/pre>\nInsert this code into the file server.js<\/code><\/b><\/p>\n\r\n \/* server.js V1 *\/\r\nconst express = require('express');\r\nconst bodyParser = require('body-parser');\r\n\r\n\/\/ create express app\r\nconst app = express();\r\n\r\n\/\/ parse requests of content-type - application\/x-www-form-urlencoded\r\napp.use(bodyParser.urlencoded({ extended: true }))\r\n\r\n\/\/ parse requests of content-type - application\/json\r\napp.use(bodyParser.json())\r\n\r\n\/\/ define a simple route\r\napp.get('\/', (req, res) => {\r\n res.json({\"message\": \"Yallah, Welcome to Country Light App. A prototype to play with Countries\"});\r\n});\r\n\r\n\/\/ listen for requests\r\napp.listen(3000, () => {\r\n console.log(\"Country Light App is up & the server is listening on port 3000\");\r\n});\r\n<\/pre>\nYour application directory node-countries-light-app<\/code> should look like this:<\/b><\/p>\n\r\nnode-countries-light-app\/\r\n|-- _node_modules\/\r\n |-- ... \r\n|-- package.json\r\n|-- package-lock.json\r\n|-- server.js\r\n<\/pre>\nSo far, you can launch the Node application with the following command. It should work! The application is available at http:\/\/localhost:3000<\/b><\/p>\n\r\n$ node server.js\r\n<\/pre>\nThe first version of the app is running on http:\/\/localhost:3000<\/b>
\n![\"Node,](\"https:\/\/flaven.fr\/wp-content\/uploads\/2018\/05\/006_node_api_testing_node_server.jpg\")
<\/p>\n
At http:\/\/localhost:3000, you get the welcome message<\/b>
\n![\"Node,](\"https:\/\/flaven.fr\/wp-content\/uploads\/2018\/05\/007_node_api_testing_node_server_localhost.jpg\")
<\/p>\n
3. SOPHISTICATING THE APP<\/H4><\/p>\n
Create the config file for the database of your Node application<\/b><\/p>\n\r\n$ mkdir config\r\n$ cd config\r\n$ touch database.config.js\r\n<\/pre>\n\r\n\/* database.config.js *\/\r\n\r\nmodule.exports = {\r\n url: 'mongodb:\/\/localhost:27017\/countries_light_app'\r\n}\r\n<\/pre>\nLaunching mongod<\/code>, mongod is the “Mongo Daemon”<\/code><\/b>
\n![\"Node,](\"https:\/\/flaven.fr\/wp-content\/uploads\/2018\/05\/009_node_api_testing_node_mongod.jpg\")
<\/p>\nLaunching mongo<\/code> and creating the database countries_light_app<\/code>, mongo is the command-line shell.<\/b>
\n![\"Node,](\"https:\/\/flaven.fr\/wp-content\/uploads\/2018\/05\/008_node_api_testing_node_mongo.jpg\")
<\/p>\nYour application directory node-countries-light-app<\/code> should look like this:<\/b><\/p>\n\r\nnode-countries-light-app\/\r\n|-- _config\/\r\n |-- database.config.js \r\n|-- _node_modules\/\r\n |-- ... \r\n|-- package.json\r\n|-- package-lock.json\r\n|-- server.js\r\n<\/pre>\nCreate the structure for the application.<\/b><\/p>\n\r\n$ mkdir -p app\/models\r\n$ cd app\/models\r\n$ touch countrie.model.js\r\n\r\n$ mkdir app\/routes\r\n$ cd app\/routes\r\n$ touch countrie.routes.js\r\n\r\n$ mkdir app\/controllers\r\n$ cd app\/controllers\r\n$ touch countrie.controller.js\r\n<\/pre>\nBe sure to have the following directory in your application directory node-countries-light-app<\/code><\/b><\/p>\n\r\nnode-countries-light-app\/\r\n|-- _app\r\n |-- _controllers\/\r\n |-- countrie.controller.js\r\n |-- _models\/\r\n |-- countrie.model.js\r\n |-- _routes\/\r\n |-- countrie.routes.js\r\n|-- _config\r\n |-- database.config.js\r\n|-- _node_modules\/\r\n |-- ...\r\n|-- package.json\r\n|-- package-lock.json\r\n|-- server.js\r\n<\/pre>\n4. CREATE THE DB<\/H4><\/p>\n
In a first window of the terminal, launch the daemon of Mongo<\/b><\/p>\n$ mongod<\/pre>\nGet into the Mongo shell<\/b><\/p>\n$ mongo<\/pre>\nPrint a list of all databases on the server<\/b><\/p>\n$ show dbs;<\/pre>\nUse the database, just by typing this command it will create the required database<\/b><\/p>\n$ use countries_light_app;<\/pre>\nSource : https:\/\/docs.mongodb.com\/manual\/reference\/mongo-shell\/<\/a><\/p>\n5. USING POSTMAN<\/H4>
\nIn postman, I have a set of queries to request this new API, leveraging on the Postman’s ability to manage environment and also to store the queries so I do not have to redo the queries again and again.<\/p>\n
5.1 USING A POSTMAN’S FILE ENVIRONMENT <\/H4>
\nThe name for file environment that is imported in Postman under the name ENV_NODE_COUNTRIES_LIGHT_APP. The file is named env_node_countries_light_app.postman_environment.json<\/code> and it contains the 2 variables {{api_root_url}} and {{api_root_url_countries}}<\/b><\/p>\n\r\n{\r\n \"id\": \"a23b2611-4076-4ea2-9ad8-9b79bccbe316\",\r\n \"name\": \"ENV_NODE_COUNTRIES_LIGHT_APP\",\r\n \"values\": [\r\n {\r\n \"key\": \"api_root_url\",\r\n \"value\": \"http:\/\/localhost:3000\",\r\n \"enabled\": true,\r\n \"type\": \"text\"\r\n },\r\n {\r\n \"key\": \"api_root_url_countries\",\r\n \"value\": \"http:\/\/localhost:3000\/countries\",\r\n \"enabled\": true,\r\n \"type\": \"text\"\r\n }\r\n ],\r\n \"_postman_variable_scope\": \"environment\",\r\n \"_postman_exported_at\": \"2018-05-22T13:48:34.707Z\",\r\n \"_postman_exported_using\": \"Postman\/6.0.10\"\r\n}\r\n<\/pre>\n5.2 USING A POSTMAN’S FILE COLLECTION<\/H4><\/p>\n
I also export all the queries into a postman’s collection in Postman
\nin the file node_countries_light_app.postman_collection.json<\/code>. There are 6 queries for CRUD operations. <\/p>\n\n- The first query: 1_welcome_api<\/b>
\nDescription: It outputs the welcome message.
\nMethod: using GET at http:\/\/localhost:3000\n<\/li>\n- The second query: 2_post_country_api<\/b>
\nDescription: It enables to post a country in the database
\nMethod: using POST at http:\/\/localhost:3000\/countries<\/p>\nCaution : Here some records to send via Postman to not have an empty database before you try to load this page.<\/b><\/p>\n\r\n{ \"name\":\"Afghanistan\", \"tld\":\".af\", \"cca2\":\"AF\", \"capital\":\"Kabul\", \"callingCode\":\"93\" }\r\n{ \"name\":\"Italy\", \"tld\":\".it\", \"cca2\":\"IT\", \"capital\":\"Rome\", \"callingCode\":\"39\" }\r\n{ \"name\":\"France\", \"tld\":\".fr\", \"cca2\":\"FR\", \"capital\":\"Paris\", \"callingCode\":\"33\" }\r\n{ \"name\":\"Malaysia\", \"tld\":\".my\", \"cca2\":\"MY\", \"capital\":\"Kuala Lumpur\", \"callingCode\":\"60\" }\r\n{ \"name\":\"Mauritania\", \"tld\":\".mr\", \"cca2\":\"MR\", \"capital\":\"Nouakchott\", \"callingCode\":\"222\" }\r\n{ \"name\":\"Tunisia\", \"tld\":\".tn\", \"cca2\":\"TN\", \"capital\":\"Tunis\", \"callingCode\":\"216\" }\r\n{ \"name\":\"Tanzania\", \"tld\":\".tz\", \"cca2\":\"TZ\", \"capital\":\"Dodoma\", \"callingCode\":\"255\" }\r\n{ \"name\":\"Seychelles\", \"tld\":\".sc\", \"cca2\":\"SC\", \"capital\":\"Victoria\", \"callingCode\":\"248\" }\r\n{ \"name\":\"Norway\", \"tld\":\".no\", \"cca2\":\"NO\", \"capital\":\"Oslo\", \"callingCode\":\"47\" }\r\n{ \"name\":\"Nepal\", \"tld\":\".np\", \"cca2\":\"NP\", \"capital\":\"Kathmandu\", \"callingCode\":\"977\" }\r\n<\/pre>\n<\/li>\n- The third query: 3_get_all_countries_api<\/b>
\nDescription: List all the countries
\nMethod: using GET \/countries\n<\/li>\n- The fourth query: 4_get_single_country_id_api<\/b>
\nDescription: Retrieving a single Country eg 5afd8c9cad99cd0a44dfc3aa
\nMethod: using GET \/countries\/:countryId
\nCaution: The id is random so be sure to use the proper id created for each country by the insertion in the database.<\/p>\n<\/li>\n- The fifth query: 5_put_update_single_country_id_api<\/b>
\nDescription: Updating a Country eg 5afd8c9cad99cd0a44dfc3aa
\nMethod: using PUT \/countries\/:countryId
\nCaution: The id is random so be sure to use the proper id created for each country by the insertion in the database.<\/p>\nUpdate with the data in Italian and not in English<\/b><\/p>\n\r\n{ \"name\":\"Italia\", \"tld\":\".it\", \"cca2\":\"IT\", \"capital\":\"Roma\", \"callingCode\":\"39\" }\r\n<\/pre>\nBring back in English if needed<\/b><\/p>\n\r\n{ \"name\":\"Italy\", \"tld\":\".it\", \"cca2\":\"IT\", \"capital\":\"Rome\", \"callingCode\":\"39\" }\r\n<\/pre>\n<\/li>\n- The sixth query: 6_delete_single_country_id_api<\/b>
\nDescription: Deleting a Country using the countryId
\nMethod: using DELETE \/countries\/:countryId
\nCaution: The id is random so be sure to use the proper id created for each country by the insertion in the database.<\/p>\n<\/li>\n<\/ul>\nRestart the application with the database with $ node server.js<\/code><\/b>
\n![\"Node,](\"https:\/\/flaven.fr\/wp-content\/uploads\/2018\/05\/012_node_api_testing_node_server_with_db.jpg\")
<\/p>\nPost few countries in the database with Postman<\/b>
\n![\"Node,](\"https:\/\/flaven.fr\/wp-content\/uploads\/2018\/05\/011_node_api_testing_node_postman_post_country.jpg\")
<\/p>\n
Check the url http:\/\/localhost:3000\/countries, you should get the list of all the countries inserted in the database.<\/b>
\n![\"Node,](\"https:\/\/flaven.fr\/wp-content\/uploads\/2018\/05\/010_node_api_testing_node_localhost.jpg\")
<\/p>\n
6. THE DOCUMENTATION USING APIDOC<\/h4>\n
Fine, you have an API but believe me it is useless without documentation because nobody will get their hands dirty with your API if it is not documented. Here is a nice easy way to create documentation with the help of the comments inside the code.<\/p>\n
To start our documentation process, first you need to create a descriptor file called apidoc.json<\/code> inside your app directory.<\/b><\/p>\n\r\n$ cd \/[path-in-your-environment]\/node-countries-light-app\/\r\n$ touch apidoc.json\r\n<\/pre>\napidoc.json<\/code> required theses attributes. You can add this content for instance in the file apidoc.json<\/code><\/b><\/p>\n\r\n{\r\n \"name\": \"Yallah Yallah, Welcome to Country Light App\",\r\n \"version\": \"1.0.1\",\r\n \"description\": \"Country Light App, a prototype to play with Countries\",\r\n \"template\": {\r\n \"forceLanguage\": \"en\"\r\n }\r\n}\r\n<\/pre>\nCreate the directory for the documentation (\/public\/apidoc) inside your app directory<\/b><\/p>\n\r\n$ mkdir public\r\n$ cd public\r\n$ mkdir apidoc\r\n<\/pre>\nAdd this line to your file server.js<\/b><\/p>\n\r\n\/\/ Serving static files from \"public\" folder.\r\n\/\/ Will be useful for apidoc\r\napp.use(express.static('public'))\r\n<\/pre>\nBe sure to have the following directory in your application directory node-countries-light-app<\/code><\/b><\/p>\n\r\nnode-countries-light-app\/\r\n|-- _app\r\n |-- _controllers\r\n |-- countrie.controller.js\r\n |-- _models\r\n |-- countrie.model.js\r\n |-- _routes\r\n |-- countrie.routes.js\r\n|-- _config\r\n |-- database.config.js\r\n|-- _node_modules\r\n |-- ... \r\n|-- _public\r\n |-- apidoc\r\n |-- ...\r\n|-- apidoc.json\r\n|-- package.json\r\n|-- package-lock.json\r\n|-- server.js\r\n<\/pre>\nApidoc by default is reading the comment that are written in the route file for instance. In my case, it will be country.routes.js<\/code>. You have to type some comments params provided by apidoc. You can do such operation for each route you want to document<\/b><\/p>\n\r\n\/\/ Create a new Country\r\n\r\n\/**\r\n * @api {post} \/countries Register a new country\r\n * @apiGroup Countries\r\n * @apiParam {String} countries.name Country name\r\n * @apiParam {String} countries.tld Country tld\r\n * @apiParam {String} countries.cca2 Country cca2\r\n * @apiParam {String} countries.capital Country capital\r\n * @apiParam {Number} countries.callingCode Country callingCode\r\n * @apiParamExample {json} Input\r\n * {\r\n * \"name\": \"Tunisia\",\r\n * \"tld\": \".tn\",\r\n * \"cca2\": \"TN\",\r\n * \"capital\": \"Tunis\",\r\n * \"callingCode\": \"216\"\r\n * }\r\n * @apiSuccess {Number} countries.id Country id\r\n * @apiSuccess {String} countries.name Country name\r\n * @apiSuccess {String} countries.tld Country tld\r\n * @apiSuccess {String} countries.cca2 Country cca2\r\n * @apiSuccess {String} countries.capital Country capital\r\n * @apiSuccess {Number} countries.callingCode Country callingCode\r\n * @apiSuccess {Date} countries.createdAt Update's date\r\n * @apiSuccess {Date} countries.updatedAt Register's date\r\n * @apiSuccessExample {json} Success\r\n * HTTP\/1.1 200 OK\r\n * {\r\n * \"_id\": \"5b041ac6e3333f03fee37042\",\r\n * \"name\": \"Tunisia\",\r\n * \"capital\": \"Tunis\",\r\n * \"tld\": \".tn\",\r\n * \"cca2\": \"TN\",\r\n * \"callingCode\": 216,\r\n * \"createdAt\": \"2018-05-22T13:27:34.919Z\",\r\n * \"updatedAt\": \"2018-05-22T13:27:34.919Z\",\r\n * \"__v\": 0\r\n * }\r\n * @apiErrorExample {json} Register error\r\n * HTTP\/1.1 500 Internal Server Error\r\n *\/\r\n<\/pre>\nSource : http:\/\/apidocjs.com\/#params
\n<\/a><\/p>\nInstall and generate the documentation using apidoc<\/b><\/p>\n\r\n$ npm install apidoc --save\r\n$ apidoc -e \"(node_modules|public)\" -o public\/apidoc\r\n<\/pre>\nThe content created by apidoc will be in the output directory public\/apidoc<\/code> and it will be available at http:\/\/localhost:3000\/apidoc<\/b><\/p>\nGenerate the documentation<\/b>
\n![\"Node,](\"https:\/\/flaven.fr\/wp-content\/uploads\/2018\/05\/014_node_api_testing_node_postman_export_apidoc.jpg\")
<\/p>\n
Browse your brand new documentation<\/b>
\n![\"Node,](\"https:\/\/flaven.fr\/wp-content\/uploads\/2018\/05\/015_node_api_testing_node_postman_export_apidoc.jpg\")
<\/p>\n
All the routes have been documented<\/b>
\n![\"Node,](\"https:\/\/flaven.fr\/wp-content\/uploads\/2018\/05\/016_node_api_testing_node_postman_export_apidoc.jpg\")
<\/p>\n
7. RUNNING THE TESTS<\/H4><\/p>\n
Create the directory the test directory inside your application<\/b><\/p>\n\r\n$ mkdir test\r\n$ touch test\/test_the_api.js\r\n<\/pre>\n\r\nnode-countries-light-app\/\r\n|-- _app\r\n |-- _controllers\r\n |-- countrie.controller.js\r\n |-- _models\r\n |-- countrie.model.js\r\n |-- _routes\r\n |-- countrie.routes.js\r\n|-- _config\r\n |-- database.config.js\r\n|-- _node_modules\r\n |-- ... \r\n|-- _public\r\n |-- apidoc\r\n |-- ... \r\n|-- test\r\n |-- test_the_api.js\r\n|-- apidoc.json\r\n|-- package.json\r\n|-- package-lock.json\r\n|-- server.js\r\n<\/pre>\nInstall Mocha, Chai and SuperTest with npm<\/b><\/p>\n\r\n$ npm install mocha chai supertest --save\r\n<\/pre>\nDo not forget to add this line to your file package.json to enable the test<\/b><\/p>\n\"scripts\": {\r\n \"test\": \"mocha test\/*.js --timeout 15000\"\r\n },\r\n<\/pre>\nLaunch the tests. It will read all the .js file inside the test directory.<\/b><\/p>\n$ npm test<\/pre>\nIntentionally, I have made an error in the first test to be sure that is currently testing the welcome message. Just in case.<\/p>\n
\r\nexpect(res.body.message).to.equal(\"Hello, hello, Yallah, Welcome to Country Light App. A prototype to play with Countries\");\r\n<\/pre>\n\r\nexpect(res.body.message).to.equal(\"Yallah, Welcome to Country Light App. A prototype to play with Countries\");\r\n<\/pre>\nInstalling mocha, chai and supertest<\/b>
\n![\"Node,](\"https:\/\/flaven.fr\/wp-content\/uploads\/2018\/05\/017_node_api_testing_node_test.jpg\")
<\/p>\n
Running the test with $ npm test<\/code><\/b>
\n![\"Node,](\"https:\/\/flaven.fr\/wp-content\/uploads\/2018\/05\/018_node_api_testing_node_running.jpg\")
<\/p>\nRunning the test with $ npm test<\/code> with an intentional error just to be sure it is working.<\/b>
\n![\"Node,](\"https:\/\/flaven.fr\/wp-content\/uploads\/2018\/05\/019_node_api_testing_node_running_failed.jpg\")
<\/p>\n8. AN EXTRA LINE AND THE CONCLUSION<\/H4><\/p>\n
To use the command npm start<\/code>, you can add this line to your file package.json<\/b><\/p>\n\r\n \"scripts\": {\r\n \"start\": \"node server.js\",\r\n \"test\": \"mocha test\/*.js --timeout 15000\"\r\n },\r\n<\/pre>\nI believe, it is a true A to Z manual of creation for a Node API. I try to shrink as much as possible the technical explanations and give the logic of a true step by step so anyone can decide to build a full documented API-POC with Node.<\/b><\/p>\n
If you download the application from github, just launch the installation with the help of file package.json with the following command.<\/b><\/p>\n$ npm install<\/pre>\n\r\n$ git clone https:\/\/github.com\/bflaven\/node-countries-light-app.git\r\n$ cd node-countries-light-app\r\n$ npm install\r\n<\/pre>\nAfter this, you can jump directly to the point 4. CREATE THE DB<\/b><\/p>\nRead more<\/h2>\n\nTutorials<\/h4>\n
- Excellent article. Very inspiring. Building a Restful CRUD API with Node.js, Express and MongoDB
https:\/\/www.callicoder.com\/node-js-express-mongodb-restful-crud-api-tutorial\/<\/a><\/li>\n- Documenting APIs using ApiDoc.js by Caio Ribeiro Pereira
https:\/\/blog.jscrambler.com\/documenting-apis-using-apidoc-js\/<\/a><\/li>\n- Build Node.js RESTful APIs in 10 Minutes
https:\/\/www.codementor.io\/olatundegaruba\/nodejs-restful-apis-in-10-minutes-q0sgsfhbd<\/a><\/li>\n- Git repository for Nodejs in 10 minutes
https:\/\/github.com\/generalgmt\/RESTfulAPITutorial<\/a><\/li>\n- How to Use json-server to Create Mock APIs
https:\/\/www.codementor.io\/ayushgupta\/how-to-use-json-server-to-create-mock-apis-0-lci958ear<\/a><\/li>\n- Create A REST API With JSON Server
https:\/\/medium.com\/codingthesmartway-com-blog\/create-a-rest-api-with-json-server-36da8680136d<\/a><\/li>\n- Build a Node.js API in Under 30 Minutes
https:\/\/medium.freecodecamp.org\/building-a-simple-node-js-api-in-under-30-minutes-a07ea9e390d2<\/a><\/li>\n- Very good article in Spanish. Testeo de API REST con Mocha y Chai-HTTP
https:\/\/www.paradigmadigital.com\/dev\/testeo-api-rest-mocha-chai-http\/<\/a><\/li>\n- Very good article in Spanish. Testeando JavaScript con Mocha y Chai
https:\/\/www.paradigmadigital.com\/dev\/testeando-javascript-mocha-chai\/<\/a><\/li>\n- Git repository for Testeo de API REST con Mocha y Chai HTTP.
https:\/\/github.com\/paradigmadigital\/ChaiHttp-sample<\/a><\/li>\nBooks and Code<\/h4>\n
- Excellent Book in Brazilian: Construindo APIs REST com Node.js
https:\/\/www.casadocodigo.com.br\/products\/livro-apis-nodejs<\/a><\/li>\n- The same in English: Building APIs with Node.js
https:\/\/leanpub.com\/building-apis-with-nodejs<\/a><\/li>\n- Git repository for Construindo APIs REST com Node.js by Caio Ribeiro Pereira
https:\/\/github.com\/caio-ribeiro-pereira\/building-apis-with-nodejs<\/a><\/li>\n- Git repository of Caio Ribeiro Pereira, the author
https:\/\/github.com\/caio-ribeiro-pereira<\/a><\/li>\n- Professional Node.js: Building Javascript Based Scalable Software
http:\/\/www.wrox.com\/WileyCDA\/WroxTitle\/Professional-Node-js-Building-Javascript-Based-Scalable-Software.productCd-1118185463.html<\/a><\/li>\nOther resources<\/h4>\n
- Introduction to Node.js API Unit Testing with Mocha and Chai
https:\/\/ubuverse.com\/introduction-to-node-js-api-unit-testing-with-mocha-and-chai\/<\/a><\/li>\n- Testing APIs with Mocha
https:\/\/blog.jscrambler.com\/testing-apis-mocha-2\/<\/a><\/li>\n- Make your node.js api bulletproof: how to test with mocha, chai, and supertest
http:\/\/developmentnow.com\/2015\/02\/05\/make-your-node-js-api-bulletproof-how-to-test-with-mocha-chai-and-supertest\/<\/a><\/li>\n- Testing Node.js with Mocha and Chai
\n
http:\/\/mherman.org\/blog\/2015\/09\/10\/testing-node-js-with-mocha-and-chai\/#.Wu1ad9OFMWo<\/a><\/li>\n- Unit test your Nodejs RESTful API using mocha
https:\/\/javascript.tutorialhorizon.com\/2014\/09\/14\/unit-test-your-nodejs-restful-api-using-mocha\/<\/a><\/li>\n- Good article. BDD in JavaScript: Getting Started with Cucumber and Gherkin
https:\/\/www.sitepoint.com\/bdd-javascript-cucumber-gherkin\/<\/a><\/li>\n- The evolution journey of Android GUI testing. Good article (the only article where some feedback and abstraction)
https:\/\/medium.com\/@sebaslogen\/the-evolution-journey-of-android-gui-testing-f65005f7ced8<\/a><\/li>\n- Good article. Into the Belly of the Beast: UI Testing an Android App with Cucumber and Espresso