Skip to content

Node week 1&2 updates #275

@magdazelena

Description

@magdazelena

Part of #268

As we will be moving authentication and security to 3rd week of Node module, weeks 1 and 2 need to be altered.

Proposal for week 1 - scope: Express

  • remove authentication bit
  • continue on Express explanation and middleware explanation with explaining error handling
    • explain error handling principals (copy from week 2)
    • adding: explain error handling in Express (ending requests or passing errors etc)
    • (to be considered) explain custom error handlers and loggers
    • all created endpoints should be added to Postman (they had it in foundation)

Notes:

  • assigments need to be updated accordingly
  • the knex methods are introduced in assigment but explained in the next week module. Suggestion: leave them in assigment + prep, skip in week 2

Proposal for week 2 - scope: Designing and documenting REST API

  • explaining REST API principles
    • designing the REST structure
  • introducing Swagger and OpenAPI
    • how to document API
  • starting with adding first endpoint, questions shall arrise around:
    • designing the error handling
    • types for parameters and payloads
  • data validation
    • validating for types etc, middleware vs per endpoint etc.
    • knex security and sql injection prevention
  • advanced postman
    • collections
    • environments
    • secrets? <-- perhaps could be left for the authentication week 3
    • testing

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions