CSE 341: Web Services

• JavaScript URIs
• Node.js - RESTful API

As you learn about these different HTTP methods, know that there are always other ways to do things. For example, MongoDB uses queries and functions to insert, update, delete and retrieve data. Technically, I could use a POST to get data, modify it, or even delete it. However, these HTTP methods are here to add clarity and consistency to applications, and will work with other databases that don't rely on functions as much as MongoDB does.

• Building a REST API with Node and Express
• MongoDB http.post()
• Building a RESTful API Using Node.JS and MongoDB
• (OPTIONAL) YouTube: Build A Restful Api With Node.js Express & MongoDB |

• Node JS Make HTTP Put Request Example
• MongoDB Update Documents
• Node.js, Express & MongoDb: Build a CRUD Rest Api example

• Node JS Make HTTP Delete Request Example
• MongoDB drop index
• Node.js MongoDB Delete

Here is a great article that sums up the CRUD (Create, Read, Update, Delete) process using Node.js and MongoDB.

• Building a Simple CRUD app with Node, Express, and MongoDB

Once you learn how to use code linters, you should never go back. When properly configured, they help keep your code, neat, clean, functional, and error-free. You should use a linter on your code for the remainder of this class.

• JavaScript Linters
• The Top Five JavaScript Linting Tools
• (OPTIONAL) YouTube: VSCode ESLint, Prettier & Airbnb Style Guide Setup

Once you learn how to use code formatters, you should never go back. When properly configured, they help keep your code neat, consistent and clean. You should use a formatter on your code for the remainder of this class.

• Why You Should Use a Code Formatter
• Top 10 VS Code Extensions
• (OPTIONAL) YouTube: VS Code Autoformatter - Configuring Prettier

The following article shows how to set up a linter and formatter with your project. You may ignore the React parts at this point, and be sure to select Node instead of Browser when it prompts for where your code will run.

• Setup ESLINT and PRETTIER

Once this is all set up, you can run commands from the terminal like: "npm run lint" or the others that we put into the package.json.

• What is API Documentation, and Why It Matters?
• (OPTIONAL) Youtube: Intro to API Documentation

• What is Swagger?
• Create swagger.json from scratch (Design First)
• Create swagger.json npm package (Development First)
• swagger-ui-express

Other Options?

Be aware that there are other resources for doing very similar types of API documentation. None of them appear to be as widely integrated with npm or as widely used in industry. Two other popular ones are Postman (which started off as just a rest client), and Readme. We will only use Swagger in this course.