reading-notes

Class 301.08

Notes

• regex site: regex101.com
• client site installation
  • npm create vite@latest
  • npm install
  • setup .env (VITE_LOCATIONIQ_API_KEY=xxx, and VITE_EXPRESS_SERVER_URL=http://localhost:3001)
  • npm install axios (and bootstrap if you want)
• server side installation (Express)
  • npm init -y // this installs the package.json
  • npm install axios cors express dotenv nodemon
  • add to package.json under scripts
    • “dev”: “nodemon index.js”,
    • “start”: “node index.js”
  • setup .env (PORT=, and other API keys)

Readings

[API Design Best Practices] (https://learn.microsoft.com/en-us/azure/architecture/best-practices/api-design)

1. What does REST stand for?

   Representational State Transfer

2. REST APIs are designed around a __.

   resources (which are any kind of object, data, or service that can be accessed by the client)

3. What is an identifier of a resource? Give an example.

   A URI, e.g. “https://adventure-works.com/orders/1”

4. What are the most common HTTP verbs?

   GET, POST, PUT, PATCH, and DELETE

5. What should the URIs be based on?

   nouns

6. Give an example of a good URI.

   GOOD: https://adventure-works.com/orders AVOID: https://adventure-works.com/create-order

7. What does it mean to have a ‘chatty’ web API? Is this a good or a bad thing?

   Normally a bad thing, chatty API’s consume resources

8. What status code does a successful GET request return?

   200

9. What status code does an unsuccessful GET request return?

   404

10. What status code does a successful POST request return?

    201

11. What status code does a successful DELETE request return?

    204

Things I want to learn more about

References

• Google Bard and ChatGPT

This site is open source. Improve this page.