Ներկայումս REST API-ն դարձել է վեբ հավելվածների մշակման ստանդարտ՝ թույլ տալով զարգացումը բաժանել անկախ մասերի։ Տարբեր հայտնի շրջանակներ, ինչպիսիք են Angular, React, Vue և այլն, ներկայումս օգտագործվում են UI-ի համար: Backend-ի մշակողները կարող են ընտրել լեզուների և շրջանակների լայն տեսականի: Այսօր ես կցանկանայի խոսել այնպիսի շրջանակի մասին, ինչպիսին NestJS. Մենք ներս ենք TestMace Մենք այն ակտիվորեն օգտագործում ենք ներքին նախագծերի համար։ Օգտագործելով բույն և փաթեթ @nestjsx/crud, մենք կստեղծենք պարզ CRUD հավելված։

Ինչու NestJS

Վերջերս JavaScript համայնքում հայտնվեցին բավականին շատ backend շրջանակներ: Իսկ եթե ֆունկցիոնալ առումով Nest-ին նմանատիպ հնարավորություններ են տալիս, ապա մի բանում այն ​​հաստատ հաղթում է՝ սա է ճարտարապետությունը։ NestJS-ի հետևյալ հնարավորությունները թույլ են տալիս ստեղծել արդյունաբերական հավելվածներ և մասշտաբային զարգացում մեծ թիմերի համար.

• օգտագործելով TypeScript-ը որպես զարգացման հիմնական լեզու: Չնայած NestJS-ն աջակցում է JavaScript-ին, որոշ գործառույթներ կարող են չաշխատել, հատկապես, եթե մենք խոսում ենք երրորդ կողմի փաթեթների մասին.
• DI կոնտեյների առկայությունը, որը թույլ է տալիս ստեղծել թույլ միացված բաղադրիչներ.
• Շրջանակի ֆունկցիոնալությունը ինքնին բաժանված է անկախ փոխանակելի բաղադրիչների: Օրինակ, գլխարկի տակ որպես շրջանակ այն կարող է օգտագործվել որպես ճեպընթացԻսկ ծոմ պահել, տվյալների բազայի հետ աշխատելու համար, nest out of the box ապահովում է կապեր տիպիկ, մանգոն, շարունակել;
• NestJS-ը պլատֆորմի ագնոստիկ է և աջակցում է REST, GraphQL, Websockets, gRPC և այլն:

Ինքնին շրջանակը ոգեշնչված է Angular frontend շրջանակից և կոնցեպտուալ առումով շատ ընդհանրություններ ունի դրա հետ:

NestJS-ի տեղադրում և նախագծի տեղակայում

Nest-ը պարունակում է փաթեթ լաբիրինթոս/cli, որը թույլ է տալիս արագ տեղակայել հիմնական հավելվածի շրջանակը: Եկեք այս փաթեթը գլոբալ տեղադրենք.

npm install --global @nest/cli

Տեղադրվելուց հետո մենք կստեղծենք մեր հավելվածի հիմնական շրջանակը անունով nest-resտ. Դա արվում է հրամանի միջոցով nest new nest-rest.

nest new nest-rest

dmitrii@dmitrii-HP-ZBook-17-G3:~/projects $ nest new nest-rest
  We will scaffold your app in a few seconds..

CREATE /nest-rest/.prettierrc (51 bytes)
CREATE /nest-rest/README.md (3370 bytes)
CREATE /nest-rest/nest-cli.json (84 bytes)
CREATE /nest-rest/nodemon-debug.json (163 bytes)
CREATE /nest-rest/nodemon.json (67 bytes)
CREATE /nest-rest/package.json (1805 bytes)
CREATE /nest-rest/tsconfig.build.json (97 bytes)
CREATE /nest-rest/tsconfig.json (325 bytes)
CREATE /nest-rest/tslint.json (426 bytes)
CREATE /nest-rest/src/app.controller.spec.ts (617 bytes)
CREATE /nest-rest/src/app.controller.ts (274 bytes)
CREATE /nest-rest/src/app.module.ts (249 bytes)
CREATE /nest-rest/src/app.service.ts (142 bytes)
CREATE /nest-rest/src/main.ts (208 bytes)
CREATE /nest-rest/test/app.e2e-spec.ts (561 bytes)
CREATE /nest-rest/test/jest-e2e.json (183 bytes)

? Which package manager would you ️ to use? yarn
 Installation in progress... 

  Successfully created project nest-rest
  Get started with the following commands:

$ cd nest-rest
$ yarn run start

                          Thanks for installing Nest 
                 Please consider donating to our open collective
                        to help us maintain this package.

                 Donate: https://opencollective.com/nest

Որպես փաթեթի կառավարիչ մենք կընտրենք մանվածքը:
Այս պահին դուք կարող եք գործարկել սերվերը հրամանով npm start և գնալով հասցեով http://localhost:3000 դուք կարող եք տեսնել հիմնական էջը: Սակայն դրա համար չէ, որ մենք հավաքվել ենք այստեղ և առաջ ենք գնում։

Տվյալների բազայի հետ աշխատանքի կարգավորում

Այս հոդվածի համար ես ընտրեցի PostrgreSQL-ը որպես DBMS: Ճաշակի հետ կապված վեճ չկա, իմ կարծիքով սա ամենահաս DBMS-ն է՝ ունենալով բոլոր անհրաժեշտ հնարավորությունները։ Ինչպես արդեն նշվեց, Nest-ը ապահովում է ինտեգրում տարբեր փաթեթների հետ տվյալների բազաների հետ աշխատելու համար։ Որովհետեւ Քանի որ իմ ընտրությունը ընկավ PostgreSQL-ի վրա, տրամաբանական կլիներ ընտրել TypeORM-ը որպես ORM: Եկեք տեղադրենք տվյալների բազայի հետ ինտեգրվելու համար անհրաժեշտ փաթեթները.

yarn add typeorm @nestjs/typeorm pg

Որպեսզի յուրաքանչյուր փաթեթ ինչի համար է անհրաժեշտ.

1. typeorm - փաթեթ անմիջապես ORM-ից.
2. @nestjs/typeorm - TypeORM փաթեթ NestJS-ի համար: Ավելացնում է մոդուլներ նախագծի մոդուլներ ներմուծելու համար, ինչպես նաև օգնական դեկորատորների մի շարք.
3. pg - վարորդ PostgreSQL-ի հետ աշխատելու համար:

Լավ, փաթեթները տեղադրված են, այժմ դուք պետք է գործարկեք տվյալների բազան հենց ինքը: Տվյալների բազան տեղակայելու համար ես կօգտագործեմ docker-compose.yml հետևյալ բովանդակությամբ.

դոկտոր-կոմպոզ.իմլ

version: '3.1'

services:
  db:
    image: postgres:11.2
    restart: always
    environment:
      POSTGRES_PASSWORD: example
    volumes:
      - ../db:/var/lib/postgresql/data
      - ./postgresql.conf:/etc/postgresql/postgresql.conf
    ports:
      - 5432:5432
  adminer:
    image: adminer
    restart: always
    ports:
      - 8080:8080

Ինչպես տեսնում եք, այս ֆայլը կարգավորում է 2 կոնտեյների գործարկումը.

1. db-ն ուղղակիորեն տվյալների բազան պարունակող կոնտեյներ է: Մեր դեպքում օգտագործվում է postgresql 11.2 տարբերակը;
2. ադմինիստրատոր - տվյալների բազայի կառավարիչ: Ապահովում է վեբ ինտերֆեյս տվյալների բազան դիտելու և կառավարելու համար:

tcp կապերի հետ աշխատելու համար ես ավելացրեցի հետևյալ կազմաձևը.

postgresql.conf

# -----------------------------
# PostgreSQL configuration file
# -----------------------------
#
# This file consists of lines of the form:
#
#   name = value
#
# (The "=" is optional.)  Whitespace may be used.  Comments are introduced with
# "#" anywhere on a line.  The complete list of parameter names and allowed
# values can be found in the PostgreSQL documentation.
#
# The commented-out settings shown in this file represent the default values.
# Re-commenting a setting is NOT sufficient to revert it to the default value;
# you need to reload the server.
#
# This file is read on server startup and when the server receives a SIGHUP
# signal.  If you edit the file on a running system, you have to SIGHUP the
# server for the changes to take effect, run "pg_ctl reload", or execute
# "SELECT pg_reload_conf()".  Some parameters, which are marked below,
# require a server shutdown and restart to take effect.
#
# Any parameter can also be given as a command-line option to the server, e.g.,
# "postgres -c log_connections=on".  Some parameters can be changed at run time
# with the "SET" SQL command.
#
# Memory units:  kB = kilobytes        Time units:  ms  = milliseconds
#                MB = megabytes                     s   = seconds
#                GB = gigabytes                     min = minutes
#                TB = terabytes                     h   = hours
#                                                   d   = days
#------------------------------------------------------------------------------
# FILE LOCATIONS
#------------------------------------------------------------------------------
# The default values of these variables are driven from the -D command-line
# option or PGDATA environment variable, represented here as ConfigDir.
#data_directory = 'ConfigDir'       # use data in another directory
# (change requires restart)
#hba_file = 'ConfigDir/pg_hba.conf' # host-based authentication file
# (change requires restart)
#ident_file = 'ConfigDir/pg_ident.conf' # ident configuration file
# (change requires restart)
# If external_pid_file is not explicitly set, no extra PID file is written.
#external_pid_file = ''         # write an extra PID file
# (change requires restart)
#------------------------------------------------------------------------------
# CONNECTIONS AND AUTHENTICATION
#------------------------------------------------------------------------------
# - Connection Settings -
listen_addresses = '*'
#listen_addresses = 'localhost'     # what IP address(es) to listen on;
# comma-separated list of addresses;
# defaults to 'localhost'; use '*' for all
# (change requires restart)
#port = 5432                # (change requires restart)
#max_connections = 100          # (change requires restart)
#superuser_reserved_connections = 3 # (change requires restart)
#unix_socket_directories = '/tmp'   # comma-separated list of directories
# (change requires restart)
#unix_socket_group = ''         # (change requires restart)
#unix_socket_permissions = 0777     # begin with 0 to use octal notation
# (change requires restart)
#bonjour = off              # advertise server via Bonjour
# (change requires restart)
#bonjour_name = ''          # defaults to the computer name
# (change requires restart)
# - TCP Keepalives -
# see "man 7 tcp" for details
#tcp_keepalives_idle = 0        # TCP_KEEPIDLE, in seconds;
# 0 selects the system default
#tcp_keepalives_interval = 0        # TCP_KEEPINTVL, in seconds;
# 0 selects the system default
#tcp_keepalives_count = 0       # TCP_KEEPCNT;
# 0 selects the system default
# - Authentication -
#authentication_timeout = 1min      # 1s-600s
#password_encryption = md5      # md5 or scram-sha-256
#db_user_namespace = off
# GSSAPI using Kerberos
#krb_server_keyfile = ''
#krb_caseins_users = off
# - SSL -
#ssl = off
#ssl_ca_file = ''
#ssl_cert_file = 'server.crt'
#ssl_crl_file = ''
#ssl_key_file = 'server.key'
#ssl_ciphers = 'HIGH:MEDIUM:+3DES:!aNULL' # allowed SSL ciphers
#ssl_prefer_server_ciphers = on
#ssl_ecdh_curve = 'prime256v1'
#ssl_min_protocol_version = 'TLSv1'
#ssl_max_protocol_version = ''
#ssl_dh_params_file = ''
#ssl_passphrase_command = ''
#ssl_passphrase_command_supports_reload = off
#------------------------------------------------------------------------------
# RESOURCE USAGE (except WAL)
#------------------------------------------------------------------------------
# - Memory -
#shared_buffers = 32MB          # min 128kB
# (change requires restart)
#huge_pages = try           # on, off, or try
# (change requires restart)
#temp_buffers = 8MB         # min 800kB
#max_prepared_transactions = 0      # zero disables the feature
# (change requires restart)
# Caution: it is not advisable to set max_prepared_transactions nonzero unless
# you actively intend to use prepared transactions.
#work_mem = 4MB             # min 64kB
#maintenance_work_mem = 64MB        # min 1MB
#autovacuum_work_mem = -1       # min 1MB, or -1 to use maintenance_work_mem
#max_stack_depth = 2MB          # min 100kB
#shared_memory_type = mmap      # the default is the first option
# supported by the operating system:
#   mmap
#   sysv
#   windows
# (change requires restart)
#dynamic_shared_memory_type = posix # the default is the first option
# supported by the operating system:
#   posix
#   sysv
#   windows
#   mmap
# (change requires restart)
# - Disk -
#temp_file_limit = -1           # limits per-process temp file space
# in kB, or -1 for no limit
# - Kernel Resources -
#max_files_per_process = 1000       # min 25
# (change requires restart)
# - Cost-Based Vacuum Delay -
#vacuum_cost_delay = 0          # 0-100 milliseconds (0 disables)
#vacuum_cost_page_hit = 1       # 0-10000 credits
#vacuum_cost_page_miss = 10     # 0-10000 credits
#vacuum_cost_page_dirty = 20        # 0-10000 credits
#vacuum_cost_limit = 200        # 1-10000 credits
# - Background Writer -
#bgwriter_delay = 200ms         # 10-10000ms between rounds
#bgwriter_lru_maxpages = 100        # max buffers written/round, 0 disables
#bgwriter_lru_multiplier = 2.0      # 0-10.0 multiplier on buffers scanned/round
#bgwriter_flush_after = 0       # measured in pages, 0 disables
# - Asynchronous Behavior -
#effective_io_concurrency = 1       # 1-1000; 0 disables prefetching
#max_worker_processes = 8       # (change requires restart)
#max_parallel_maintenance_workers = 2   # taken from max_parallel_workers
#max_parallel_workers_per_gather = 2    # taken from max_parallel_workers
#parallel_leader_participation = on
#max_parallel_workers = 8       # maximum number of max_worker_processes that
# can be used in parallel operations
#old_snapshot_threshold = -1        # 1min-60d; -1 disables; 0 is immediate
# (change requires restart)
#backend_flush_after = 0        # measured in pages, 0 disables
#------------------------------------------------------------------------------
# WRITE-AHEAD LOG
#------------------------------------------------------------------------------
# - Settings -
#wal_level = replica            # minimal, replica, or logical
# (change requires restart)
#fsync = on             # flush data to disk for crash safety
# (turning this off can cause
# unrecoverable data corruption)
#synchronous_commit = on        # synchronization level;
# off, local, remote_write, remote_apply, or on
#wal_sync_method = fsync        # the default is the first option
# supported by the operating system:
#   open_datasync
#   fdatasync (default on Linux)
#   fsync
#   fsync_writethrough
#   open_sync
#full_page_writes = on          # recover from partial page writes
#wal_compression = off          # enable compression of full-page writes
#wal_log_hints = off            # also do full page writes of non-critical updates
# (change requires restart)
#wal_buffers = -1           # min 32kB, -1 sets based on shared_buffers
# (change requires restart)
#wal_writer_delay = 200ms       # 1-10000 milliseconds
#wal_writer_flush_after = 1MB       # measured in pages, 0 disables
#commit_delay = 0           # range 0-100000, in microseconds
#commit_siblings = 5            # range 1-1000
# - Checkpoints -
#checkpoint_timeout = 5min      # range 30s-1d
#max_wal_size = 1GB
#min_wal_size = 80MB
#checkpoint_completion_target = 0.5 # checkpoint target duration, 0.0 - 1.0
#checkpoint_flush_after = 0     # measured in pages, 0 disables
#checkpoint_warning = 30s       # 0 disables
# - Archiving -
#archive_mode = off     # enables archiving; off, on, or always
# (change requires restart)
#archive_command = ''       # command to use to archive a logfile segment
# placeholders: %p = path of file to archive
#               %f = file name only
# e.g. 'test ! -f /mnt/server/archivedir/%f && cp %p /mnt/server/archivedir/%f'
#archive_timeout = 0        # force a logfile segment switch after this
# number of seconds; 0 disables
# - Archive Recovery -
# These are only used in recovery mode.
#restore_command = ''       # command to use to restore an archived logfile segment
# placeholders: %p = path of file to restore
#               %f = file name only
# e.g. 'cp /mnt/server/archivedir/%f %p'
# (change requires restart)
#archive_cleanup_command = ''   # command to execute at every restartpoint
#recovery_end_command = ''  # command to execute at completion of recovery
# - Recovery Target -
# Set these only when performing a targeted recovery.
#recovery_target = ''       # 'immediate' to end recovery as soon as a
# consistent state is reached
# (change requires restart)
#recovery_target_name = ''  # the named restore point to which recovery will proceed
# (change requires restart)
#recovery_target_time = ''  # the time stamp up to which recovery will proceed
# (change requires restart)
#recovery_target_xid = ''   # the transaction ID up to which recovery will proceed
# (change requires restart)
#recovery_target_lsn = ''   # the WAL LSN up to which recovery will proceed
# (change requires restart)
#recovery_target_inclusive = on # Specifies whether to stop:
# just after the specified recovery target (on)
# just before the recovery target (off)
# (change requires restart)
#recovery_target_timeline = 'latest'    # 'current', 'latest', or timeline ID
# (change requires restart)
#recovery_target_action = 'pause'   # 'pause', 'promote', 'shutdown'
# (change requires restart)
#------------------------------------------------------------------------------
# REPLICATION
#------------------------------------------------------------------------------
# - Sending Servers -
# Set these on the master and on any standby that will send replication data.
#max_wal_senders = 10       # max number of walsender processes
# (change requires restart)
#wal_keep_segments = 0      # in logfile segments; 0 disables
#wal_sender_timeout = 60s   # in milliseconds; 0 disables
#max_replication_slots = 10 # max number of replication slots
# (change requires restart)
#track_commit_timestamp = off   # collect timestamp of transaction commit
# (change requires restart)
# - Master Server -
# These settings are ignored on a standby server.
#synchronous_standby_names = '' # standby servers that provide sync rep
# method to choose sync standbys, number of sync standbys,
# and comma-separated list of application_name
# from standby(s); '*' = all
#vacuum_defer_cleanup_age = 0   # number of xacts by which cleanup is delayed
# - Standby Servers -
# These settings are ignored on a master server.
#primary_conninfo = ''          # connection string to sending server
# (change requires restart)
#primary_slot_name = ''         # replication slot on sending server
# (change requires restart)
#promote_trigger_file = ''      # file name whose presence ends recovery
#hot_standby = on           # "off" disallows queries during recovery
# (change requires restart)
#max_standby_archive_delay = 30s    # max delay before canceling queries
# when reading WAL from archive;
# -1 allows indefinite delay
#max_standby_streaming_delay = 30s  # max delay before canceling queries
# when reading streaming WAL;
# -1 allows indefinite delay
#wal_receiver_status_interval = 10s # send replies at least this often
# 0 disables
#hot_standby_feedback = off     # send info from standby to prevent
# query conflicts
#wal_receiver_timeout = 60s     # time that receiver waits for
# communication from master
# in milliseconds; 0 disables
#wal_retrieve_retry_interval = 5s   # time to wait before retrying to
# retrieve WAL after a failed attempt
#recovery_min_apply_delay = 0       # minimum delay for applying changes during recovery
# - Subscribers -
# These settings are ignored on a publisher.
#max_logical_replication_workers = 4    # taken from max_worker_processes
# (change requires restart)
#max_sync_workers_per_subscription = 2  # taken from max_logical_replication_workers
#------------------------------------------------------------------------------
# QUERY TUNING
#------------------------------------------------------------------------------
# - Planner Method Configuration -
#enable_bitmapscan = on
#enable_hashagg = on
#enable_hashjoin = on
#enable_indexscan = on
#enable_indexonlyscan = on
#enable_material = on
#enable_mergejoin = on
#enable_nestloop = on
#enable_parallel_append = on
#enable_seqscan = on
#enable_sort = on
#enable_tidscan = on
#enable_partitionwise_join = off
#enable_partitionwise_aggregate = off
#enable_parallel_hash = on
#enable_partition_pruning = on
# - Planner Cost Constants -
#seq_page_cost = 1.0            # measured on an arbitrary scale
#random_page_cost = 4.0         # same scale as above
#cpu_tuple_cost = 0.01          # same scale as above
#cpu_index_tuple_cost = 0.005       # same scale as above
#cpu_operator_cost = 0.0025     # same scale as above
#parallel_tuple_cost = 0.1      # same scale as above
#parallel_setup_cost = 1000.0   # same scale as above
#jit_above_cost = 100000        # perform JIT compilation if available
# and query more expensive than this;
# -1 disables
#jit_inline_above_cost = 500000     # inline small functions if query is
# more expensive than this; -1 disables
#jit_optimize_above_cost = 500000   # use expensive JIT optimizations if
# query is more expensive than this;
# -1 disables
#min_parallel_table_scan_size = 8MB
#min_parallel_index_scan_size = 512kB
#effective_cache_size = 4GB
# - Genetic Query Optimizer -
#geqo = on
#geqo_threshold = 12
#geqo_effort = 5            # range 1-10
#geqo_pool_size = 0         # selects default based on effort
#geqo_generations = 0           # selects default based on effort
#geqo_selection_bias = 2.0      # range 1.5-2.0
#geqo_seed = 0.0            # range 0.0-1.0
# - Other Planner Options -
#default_statistics_target = 100    # range 1-10000
#constraint_exclusion = partition   # on, off, or partition
#cursor_tuple_fraction = 0.1        # range 0.0-1.0
#from_collapse_limit = 8
#join_collapse_limit = 8        # 1 disables collapsing of explicit
# JOIN clauses
#force_parallel_mode = off
#jit = on               # allow JIT compilation
#plan_cache_mode = auto         # auto, force_generic_plan or
# force_custom_plan
#------------------------------------------------------------------------------
# REPORTING AND LOGGING
#------------------------------------------------------------------------------
# - Where to Log -
#log_destination = 'stderr'     # Valid values are combinations of
# stderr, csvlog, syslog, and eventlog,
# depending on platform.  csvlog
# requires logging_collector to be on.
# This is used when logging to stderr:
#logging_collector = off        # Enable capturing of stderr and csvlog
# into log files. Required to be on for
# csvlogs.
# (change requires restart)
# These are only used if logging_collector is on:
#log_directory = 'log'          # directory where log files are written,
# can be absolute or relative to PGDATA
#log_filename = 'postgresql-%Y-%m-%d_%H%M%S.log'    # log file name pattern,
# can include strftime() escapes
#log_file_mode = 0600           # creation mode for log files,
# begin with 0 to use octal notation
#log_truncate_on_rotation = off     # If on, an existing log file with the
# same name as the new log file will be
# truncated rather than appended to.
# But such truncation only occurs on
# time-driven rotation, not on restarts
# or size-driven rotation.  Default is
# off, meaning append to existing files
# in all cases.
#log_rotation_age = 1d          # Automatic rotation of logfiles will
# happen after that time.  0 disables.
#log_rotation_size = 10MB       # Automatic rotation of logfiles will
# happen after that much log output.
# 0 disables.
# These are relevant when logging to syslog:
#syslog_facility = 'LOCAL0'
#syslog_ident = 'postgres'
#syslog_sequence_numbers = on
#syslog_split_messages = on
# This is only relevant when logging to eventlog (win32):
# (change requires restart)
#event_source = 'PostgreSQL'
# - When to Log -
#log_min_messages = warning     # values in order of decreasing detail:
#   debug5
#   debug4
#   debug3
#   debug2
#   debug1
#   info
#   notice
#   warning
#   error
#   log
#   fatal
#   panic
#log_min_error_statement = error    # values in order of decreasing detail:
#   debug5
#   debug4
#   debug3
#   debug2
#   debug1
#   info
#   notice
#   warning
#   error
#   log
#   fatal
#   panic (effectively off)
#log_min_duration_statement = -1    # logs statements and their durations
# according to log_statement_sample_rate. -1 is disabled,
# 0 logs all statement, > 0 logs only statements running at
# least this number of milliseconds.
#log_statement_sample_rate = 1  # Fraction of logged statements over
# log_min_duration_statement. 1.0 logs all statements,
# 0 never logs.
# - What to Log -
#debug_print_parse = off
#debug_print_rewritten = off
#debug_print_plan = off
#debug_pretty_print = on
#log_checkpoints = off
#log_connections = off
#log_disconnections = off
#log_duration = off
#log_error_verbosity = default      # terse, default, or verbose messages
#log_hostname = off
#log_line_prefix = '%m [%p] '       # special values:
#   %a = application name
#   %u = user name
#   %d = database name
#   %r = remote host and port
#   %h = remote host
#   %p = process ID
#   %t = timestamp without milliseconds
#   %m = timestamp with milliseconds
#   %n = timestamp with milliseconds (as a Unix epoch)
#   %i = command tag
#   %e = SQL state
#   %c = session ID
#   %l = session line number
#   %s = session start timestamp
#   %v = virtual transaction ID
#   %x = transaction ID (0 if none)
#   %q = stop here in non-session
#        processes
#   %% = '%'
# e.g. '<%u%%%d> '
#log_lock_waits = off           # log lock waits >= deadlock_timeout
#log_statement = 'none'         # none, ddl, mod, all
#log_replication_commands = off
#log_temp_files = -1            # log temporary files equal or larger
# than the specified size in kilobytes;
# -1 disables, 0 logs all temp files
#log_timezone = 'GMT'
#------------------------------------------------------------------------------
# PROCESS TITLE
#------------------------------------------------------------------------------
#cluster_name = ''          # added to process titles if nonempty
# (change requires restart)
#update_process_title = on
#------------------------------------------------------------------------------
# STATISTICS
#------------------------------------------------------------------------------
# - Query and Index Statistics Collector -
#track_activities = on
#track_counts = on
#track_io_timing = off
#track_functions = none         # none, pl, all
#track_activity_query_size = 1024   # (change requires restart)
#stats_temp_directory = 'pg_stat_tmp'
# - Monitoring -
#log_parser_stats = off
#log_planner_stats = off
#log_executor_stats = off
#log_statement_stats = off
#------------------------------------------------------------------------------
# AUTOVACUUM
#------------------------------------------------------------------------------
#autovacuum = on            # Enable autovacuum subprocess?  'on'
# requires track_counts to also be on.
#log_autovacuum_min_duration = -1   # -1 disables, 0 logs all actions and
# their durations, > 0 logs only
# actions running at least this number
# of milliseconds.
#autovacuum_max_workers = 3     # max number of autovacuum subprocesses
# (change requires restart)
#autovacuum_naptime = 1min      # time between autovacuum runs
#autovacuum_vacuum_threshold = 50   # min number of row updates before
# vacuum
#autovacuum_analyze_threshold = 50  # min number of row updates before
# analyze
#autovacuum_vacuum_scale_factor = 0.2   # fraction of table size before vacuum
#autovacuum_analyze_scale_factor = 0.1  # fraction of table size before analyze
#autovacuum_freeze_max_age = 200000000  # maximum XID age before forced vacuum
# (change requires restart)
#autovacuum_multixact_freeze_max_age = 400000000    # maximum multixact age
# before forced vacuum
# (change requires restart)
#autovacuum_vacuum_cost_delay = 2ms # default vacuum cost delay for
# autovacuum, in milliseconds;
# -1 means use vacuum_cost_delay
#autovacuum_vacuum_cost_limit = -1  # default vacuum cost limit for
# autovacuum, -1 means use
# vacuum_cost_limit
#------------------------------------------------------------------------------
# CLIENT CONNECTION DEFAULTS
#------------------------------------------------------------------------------
# - Statement Behavior -
#client_min_messages = notice       # values in order of decreasing detail:
#   debug5
#   debug4
#   debug3
#   debug2
#   debug1
#   log
#   notice
#   warning
#   error
#search_path = '"$user", public'    # schema names
#row_security = on
#default_tablespace = ''        # a tablespace name, '' uses the default
#temp_tablespaces = ''          # a list of tablespace names, '' uses
# only default tablespace
#check_function_bodies = on
#default_transaction_isolation = 'read committed'
#default_transaction_read_only = off
#default_transaction_deferrable = off
#session_replication_role = 'origin'
#statement_timeout = 0          # in milliseconds, 0 is disabled
#lock_timeout = 0           # in milliseconds, 0 is disabled
#idle_in_transaction_session_timeout = 0    # in milliseconds, 0 is disabled
#vacuum_freeze_min_age = 50000000
#vacuum_freeze_table_age = 150000000
#vacuum_multixact_freeze_min_age = 5000000
#vacuum_multixact_freeze_table_age = 150000000
#vacuum_cleanup_index_scale_factor = 0.1    # fraction of total number of tuples
# before index cleanup, 0 always performs
# index cleanup
#bytea_output = 'hex'           # hex, escape
#xmlbinary = 'base64'
#xmloption = 'content'
#gin_fuzzy_search_limit = 0
#gin_pending_list_limit = 4MB
# - Locale and Formatting -
#datestyle = 'iso, mdy'
#intervalstyle = 'postgres'
#timezone = 'GMT'
#timezone_abbreviations = 'Default'     # Select the set of available time zone
# abbreviations.  Currently, there are
#   Default
#   Australia (historical usage)
#   India
# You can create your own file in
# share/timezonesets/.
#extra_float_digits = 1         # min -15, max 3; any value >0 actually
# selects precise output mode
#client_encoding = sql_ascii        # actually, defaults to database
# encoding
# These settings are initialized by initdb, but they can be changed.
#lc_messages = 'C'          # locale for system error message
# strings
#lc_monetary = 'C'          # locale for monetary formatting
#lc_numeric = 'C'           # locale for number formatting
#lc_time = 'C'              # locale for time formatting
# default configuration for text search
#default_text_search_config = 'pg_catalog.simple'
# - Shared Library Preloading -
#shared_preload_libraries = ''  # (change requires restart)
#local_preload_libraries = ''
#session_preload_libraries = ''
#jit_provider = 'llvmjit'       # JIT library to use
# - Other Defaults -
#dynamic_library_path = '$libdir'
#------------------------------------------------------------------------------
# LOCK MANAGEMENT
#------------------------------------------------------------------------------
#deadlock_timeout = 1s
#max_locks_per_transaction = 64     # min 10
# (change requires restart)
#max_pred_locks_per_transaction = 64    # min 10
# (change requires restart)
#max_pred_locks_per_relation = -2   # negative values mean
# (max_pred_locks_per_transaction
#  / -max_pred_locks_per_relation) - 1
#max_pred_locks_per_page = 2            # min 0
#------------------------------------------------------------------------------
# VERSION AND PLATFORM COMPATIBILITY
#------------------------------------------------------------------------------
# - Previous PostgreSQL Versions -
#array_nulls = on
#backslash_quote = safe_encoding    # on, off, or safe_encoding
#escape_string_warning = on
#lo_compat_privileges = off
#operator_precedence_warning = off
#quote_all_identifiers = off
#standard_conforming_strings = on
#synchronize_seqscans = on
# - Other Platforms and Clients -
#transform_null_equals = off
#------------------------------------------------------------------------------
# ERROR HANDLING
#------------------------------------------------------------------------------
#exit_on_error = off            # terminate session on any error?
#restart_after_crash = on       # reinitialize after backend crash?
#data_sync_retry = off          # retry or panic on failure to fsync
# data?
# (change requires restart)
#------------------------------------------------------------------------------
# CONFIG FILE INCLUDES
#------------------------------------------------------------------------------
# These options allow settings to be loaded from files other than the
# default postgresql.conf.
#include_dir = 'conf.d'         # include files ending in '.conf' from
# directory 'conf.d'
#include_if_exists = 'exists.conf'  # include file only if it exists
#include = 'special.conf'       # include file
#------------------------------------------------------------------------------
# CUSTOMIZED OPTIONS
#------------------------------------------------------------------------------
# Add settings for extensions here

Այսքանը, դուք կարող եք սկսել կոնտեյներներ հրամանով docker-compose up -d. Կամ հրամանով առանձին վահանակում docker-compose up.

Այսպիսով, փաթեթները տեղադրվել են, տվյալների բազան գործարկվել է, մնում է միայն ընկերություն անել միմյանց հետ։ Դա անելու համար անհրաժեշտ է ծրագրի արմատին ավելացնել հետևյալ ֆայլը՝ ormconfig.js:

ormconfig.js

const process = require('process');
const username = process.env.POSTGRES_USER || "postgres";
const password = process.env.POSTGRES_PASSWORD || "example";
module.exports = {
"type": "postgres",
"host": "localhost",
"port": 5432,
username,
password,
"database": "postgres",
"synchronize": true,
"dropSchema": false,
"logging": true,
"entities": [__dirname + "/src/**/*.entity.ts", __dirname + "/dist/**/*.entity.js"],
"migrations": ["migrations/**/*.ts"],
"subscribers": ["subscriber/**/*.ts", "dist/subscriber/**/.js"],
"cli": {
"entitiesDir": "src",
"migrationsDir": "migrations",
"subscribersDir": "subscriber"
}
}

Այս կոնֆիգուրացիան կօգտագործվի cli typeorm-ի համար:

Եկեք նայենք այս կազմաձևին ավելի մանրամասն: 3-րդ և 4-րդ տողերում մենք ստանում ենք օգտվողի անունը և գաղտնաբառը շրջակա միջավայրի փոփոխականներից: Սա հարմար է, երբ դուք ունեք մի քանի միջավայրեր (dev, stage, prod և այլն): Լռելյայնորեն օգտագործողի անունը postgres է, իսկ գաղտնաբառը՝ օրինակ: Կազմաձևի մնացած մասը չնչին է, ուստի մենք կկենտրոնանանք միայն ամենահետաքրքիր պարամետրերի վրա.

• համաժամանակացնել - Ցույց է տալիս, թե արդյոք տվյալների բազայի սխեման պետք է ավտոմատ կերպով ստեղծվի, երբ դիմումը սկսվի: Զգույշ եղեք այս տարբերակի հետ և մի օգտագործեք այն արտադրության մեջ, այլապես կկորցնեք տվյալները: Այս տարբերակը հարմար է հավելված մշակելիս և վրիպազերծելիս: Որպես այլընտրանք այս տարբերակին, կարող եք օգտագործել հրամանը schema:sync CLI TypeORM-ից:
• dropSchema - վերակայել սխեման ամեն անգամ, երբ կապ է հաստատվում: Ինչպես նախորդը, այս տարբերակը պետք է օգտագործվի միայն հավելվածի մշակման և վրիպազերծման ժամանակ։
• սուբյեկտներ - մոդելների նկարագրություններ փնտրելու ուղիները: Խնդրում ենք նկատի ունենալ, որ դիմակով որոնումն ապահովված է:
• cli.entitiesDir-ը այն գրացուցակն է, որտեղ լռելյայն պետք է պահվեն TypeORM CLI-ից ստեղծված մոդելները:

Որպեսզի մենք կարողանանք օգտագործել TypeORM-ի բոլոր հնարավորությունները մեր Nest հավելվածում, մենք պետք է ներմուծենք մոդուլը: TypeOrmModule в AppModule. Նրանք. քո AppModule կունենա հետևյալ տեսքը.

app.module.ts

import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { TypeOrmModule } from '@nestjs/typeorm';
import * as process from "process";
const username = process.env.POSTGRES_USER || 'postgres';
const password = process.env.POSTGRES_PASSWORD || 'example';
@Module({
imports: [
TypeOrmModule.forRoot({
type: 'postgres',
host: 'localhost',
port: 5432,
username,
password,
database: 'postgres',
entities: [__dirname + '/**/*.entity{.ts,.js}'],
synchronize: true,
}),
],
controllers: [AppController],
providers: [AppService],
})
export class AppModule {}

Ինչպես նկատել եք, մեթոդը forRoot Տվյալների բազայի հետ աշխատելու նույն կոնֆիգուրացիան փոխանցվում է ինչպես ormconfig.ts ֆայլում

Վերջնական հպումը մնում է. package.json-ում ավելացրեք մի քանի առաջադրանքներ TypeORM-ի հետ աշխատելու համար: Փաստն այն է, որ CLI-ն գրված է javascript-ով և աշխատում է nodejs միջավայրում։ Այնուամենայնիվ, մեր բոլոր մոդելները և միգրացիաները գրվելու են մեքենագրությամբ: Հետևաբար, CLI-ն օգտագործելուց առաջ անհրաժեշտ է թարգմանել մեր միգրացիաներն ու մոդելները: Դրա համար մեզ անհրաժեշտ է ts-node փաթեթը.

yarn add -D ts-node

Դրանից հետո փաթեթ.json-ին ավելացրեք անհրաժեշտ հրամանները.

"typeorm": "ts-node -r tsconfig-paths/register ./node_modules/typeorm/cli.js",
"migration:generate": "yarn run typeorm migration:generate -n",
"migration:create": "yarn run typeorm migration:create -n",
"migration:run": "yarn run typeorm migration:run"

Առաջին հրամանը՝ typeorm-ը, ավելացնում է ts-node wrapper՝ TypeORM cli-ն գործարկելու համար: Մնացած հրամանները հարմար դյուրանցումներ են, որոնք դուք, որպես մշակող, կօգտագործեք գրեթե ամեն օր.
migration:generate — ստեղծել միգրացիաներ՝ հիմնված ձեր մոդելների փոփոխությունների վրա:
migration:create — ստեղծել դատարկ միգրացիա:
migration:run - միգրացիաների մեկնարկը:
Դե, դա հիմա է, մենք ավելացրել ենք անհրաժեշտ փաթեթները, կարգավորել ենք հավելվածը տվյալների բազայի հետ աշխատելու համար ինչպես cli-ից, այնպես էլ հենց հավելվածից, ինչպես նաև գործարկել ենք DBMS-ը: Ժամանակն է տրամաբանություն ավելացնել մեր հավելվածին։

CRUD-ի ստեղծման համար փաթեթների տեղադրում

Օգտագործելով միայն Nest-ը, դուք կարող եք ստեղծել API, որը թույլ է տալիս ստեղծել, կարդալ, թարմացնել և ջնջել օբյեկտ: Այս լուծումը կլինի հնարավորինս ճկուն, բայց որոշ դեպքերում այն ​​կլինի ավելորդ։ Օրինակ, եթե ձեզ անհրաժեշտ է արագ ստեղծել նախատիպ, դուք հաճախ կարող եք զոհաբերել ճկունությունը զարգացման արագության համար: Շատ շրջանակներ ապահովում են CRUD-ի ստեղծման ֆունկցիոնալությունը՝ նկարագրելով որոշակի կազմակերպության տվյալների մոդելը: Եվ Nest-ը բացառություն չէ: Այս ֆունկցիոնալությունը տրամադրվում է փաթեթով @nestjsx/crud. Նրա հնարավորությունները շատ հետաքրքիր են.

• հեշտ տեղադրում և կազմաձևում;
• DBMS անկախություն;
• հարցումների հզոր լեզու՝ զտելու, էջադրելու, տեսակավորելու, փոխհարաբերությունների և ներդիրների բեռնման, քեշավորման և այլնի ունակությամբ;
• փաթեթ՝ ճակատային մասում հարցումներ ստեղծելու համար.
• վերահսկիչի մեթոդների հեշտ հաղթահարում;
• փոքր կոնֆիգուրացիա;
• swagger փաստաթղթերի աջակցություն:

Ֆունկցիոնալությունը բաժանված է մի քանի փաթեթների.

• @nestjsx/crud - հիմնական փաթեթը, որը տրամադրում է դեկորատորը Քրուդ() երթուղու ստեղծման, կազմաձևման և վավերացման համար.
• @nestjsx/crud-request — փաթեթ, որն ապահովում է հարցումների ստեղծող/վերլուծիչ՝ ճակատային մասում օգտագործելու համար.
• @nestjsx/crud-typeorm — TypeORM-ի հետ ինտեգրման փաթեթ, որն ապահովում է հիմնական TypeOrmCrudService ծառայությունը CRUD մեթոդներով՝ տվյալների բազայում գտնվող անձանց հետ աշխատելու համար:

Այս ձեռնարկում մեզ անհրաժեշտ կլինեն փաթեթներ լաբիրինթոսjsx/crud և լաբիրինթոսjsx/crud-typeorm. Նախ, եկեք դրանք դնենք

yarn add @nestjsx/crud class-transformer class-validator

Փաթեթներ դաս-տրանսֆորմատոր и դասի վավերացնող այս հավելվածում պահանջվում է համապատասխանաբար մոդելային օրինակների վերափոխման և մուտքային հարցումների վավերացման կանոնների դեկլարատիվ նկարագրությունը: Այս փաթեթները նույն հեղինակից են, ուստի միջերեսները նման են:

CRUD-ի ուղղակի իրականացում

Որպես մոդելի օրինակ մենք կվերցնենք օգտվողների ցուցակը: Օգտագործողները կունենան հետևյալ դաշտերը. id, username, displayName, email. id - ավտոմատ աճող դաշտ, email и username - եզակի դաշտեր. Դա պարզ է! Մնում է միայն իրականացնել մեր գաղափարը Nest հավելվածի տեսքով։
Նախ անհրաժեշտ է ստեղծել մոդուլ users, ովքեր պատասխանատու կլինեն օգտատերերի հետ աշխատելու համար: Եկեք օգտագործենք NestJS-ի cli-ն և կատարենք հրամանը մեր նախագծի արմատական ​​գրացուցակում nest g module users.

nest g մոդուլի օգտագործողներ

dmitrii@dmitrii-HP-ZBook-17-G3:~/projects/nest-rest git:(master*)$ nest g module users
CREATE /src/users/users.module.ts (82 bytes)
UPDATE /src/app.module.ts (312 bytes)

Այս մոդուլում մենք կավելացնենք entities թղթապանակ, որտեղ կունենանք այս մոդուլի մոդելները։ Մասնավորապես, եկեք այստեղ ավելացնենք user.entity.ts ֆայլը՝ օգտատիրոջ մոդելի նկարագրությամբ.

user.entity.ts

import { Column, Entity, PrimaryGeneratedColumn } from 'typeorm';
@Entity()
export class User {
@PrimaryGeneratedColumn()
id: string;
@Column({unique: true})
email: string;
@Column({unique: true})
username: string;
@Column({nullable: true})
displayName: string;
}

Որպեսզի այս մոդելը «տեսնի» մեր հավելվածի կողմից, անհրաժեշտ է մոդուլում UsersModule ներմուծում TypeOrmModule հետևյալ բովանդակությունը.

users.module.ts

import { Module } from '@nestjs/common';
import { UsersController } from './controllers/users/users.controller';
import { UsersService } from './services/users/users.service';
import { TypeOrmModule } from '@nestjs/typeorm';
import { User } from './entities/user.entity';
@Module({
controllers: [UsersController],
providers: [UsersService],
imports: [
TypeOrmModule.forFeature([User])
]
})
export class UsersModule {}

Այսինքն՝ այստեղ մենք ներմուծում ենք TypeOrmModule, որտեղ որպես մեթոդի պարամետր forFeature Մենք նշում ենք այս մոդուլի հետ կապված մոդելների ցանկը:

Մնում է միայն ստեղծել տվյալների բազայում համապատասխան սուբյեկտը: Այս նպատակներին է ծառայում միգրացիոն մեխանիզմը։ Մոդելների փոփոխությունների հիման վրա միգրացիա ստեղծելու համար հարկավոր է գործարկել հրամանը npm run migration:generate -- CreateUserTable:

սփոյլերի վերնագիր

$ npm run migration:generate -- CreateUserTable
Migration /home/dmitrii/projects/nest-rest/migrations/1563346135367-CreateUserTable.ts has been generated successfully.
Done in 1.96s.

Պետք չէր միգրացիան ձեռքով գրել, ամեն ինչ կախարդական է եղել։ Սա հրաշք չէ՞։ Այնուամենայնիվ, սա դեռ ամենը չէ: Եկեք նայենք ստեղծված միգրացիոն ֆայլին.

1563346135367-CreateUserTable.ts

import {MigrationInterface, QueryRunner} from "typeorm";
export class CreateUserTable1563346816726 implements MigrationInterface {
public async up(queryRunner: QueryRunner): Promise<any> {
await queryRunner.query(`CREATE TABLE "user" ("id" SERIAL NOT NULL, "email" character varying NOT NULL, "username" character varying NOT NULL, "displayName" character varying, CONSTRAINT "UQ_e12875dfb3b1d92d7d7c5377e22" UNIQUE ("email"), CONSTRAINT "UQ_78a916df40e02a9deb1c4b75edb" UNIQUE ("username"), CONSTRAINT "PK_cace4a159ff9f2512dd42373760" PRIMARY KEY ("id"))`);
}
public async down(queryRunner: QueryRunner): Promise<any> {
await queryRunner.query(`DROP TABLE "user"`);
}
}

Ինչպես տեսնում եք, ավտոմատ կերպով ստեղծվել է ոչ միայն միգրացիան սկսելու մեթոդը, այլև այն ետ վերադարձնելու եղանակը։ Ֆանտաստիկ!
Մնում է միայն սկսել այս միգրացիան: Դա արվում է հետևյալ հրամանով.

npm run migration:run.

Վերջ, հիմա սխեմայի փոփոխությունները տեղափոխվել են տվյալների բազա։
Հաջորդը, մենք կստեղծենք ծառայություն, որը պատասխանատու կլինի օգտատերերի հետ աշխատելու և այն ժառանգելու համար TypeOrmCrudService. Հետաքրքրված անձի պահոցը պետք է փոխանցվի մայր կառուցողի պարամետրին, մեր դեպքում User պահոց.

users.service.ts

import { Injectable } from '@nestjs/common';
import { TypeOrmCrudService } from '@nestjsx/crud-typeorm';
import { User } from '../../entities/user.entity';
import { InjectRepository } from '@nestjs/typeorm';
import { Repository } from 'typeorm';
@Injectable()
export class UsersService extends TypeOrmCrudService<User>{
constructor(@InjectRepository(User) usersRepository: Repository<User>){
super(usersRepository);
}
}

Այս ծառայությունը մեզ անհրաժեշտ կլինի վերահսկիչում users. Կարգավորիչ ստեղծելու համար մուտքագրեք վահանակում nest g controller users/controllers/users

nest g վերահսկիչ օգտվողներ/կարգավորիչներ/օգտատերեր

dmitrii@dmitrii-HP-ZBook-17-G3:~/projects/nest-rest git:(master*)$ nest g controller users/controllers/users
CREATE /src/users/controllers/users/users.controller.spec.ts (486 bytes)
CREATE /src/users/controllers/users/users.controller.ts (99 bytes)
UPDATE /src/users/users.module.ts (188 bytes)

Եկեք բացենք այս կարգավորիչը և խմբագրենք այն՝ մի փոքր կախարդանք ավելացնելու համար լաբիրինթոսjsx/crud. Մեկ դասի համար UsersController Ավելացնենք այսպիսի դեկորատոր.

@Crud({
model: {
type: User
}
})

Քրուդ դեկորատոր է, որը կարգավորիչին ավելացնում է մոդելի հետ աշխատելու անհրաժեշտ մեթոդները։ Մոդելի տեսակը նշված է դաշտում model.type դեկորատորի կոնֆիգուրացիաներ.
Երկրորդ քայլը ինտերֆեյսի իրականացումն է CrudController<User>. «Հավաքված» վերահսկիչի կոդը հետևյալ տեսքն ունի.

import { Controller } from '@nestjs/common';
import { Crud, CrudController } from '@nestjsx/crud';
import { User } from '../../entities/user.entity';
import { UsersService } from '../../services/users/users.service';
@Crud({
model: {
type: User
}
})
@Controller('users')
export class UsersController implements CrudController<User>{
constructor(public service: UsersService){}
}

Եվ դա բոլորը! Այժմ վերահսկիչը աջակցում է մոդելի հետ գործառնությունների ամբողջ շարքը: Չե՞ք հավատում ինձ: Եկեք փորձենք մեր դիմումը գործողության մեջ:

TestMace-ում Query Script-ի ստեղծում

Մեր ծառայությունը փորձարկելու համար մենք կօգտագործենք IDE՝ API-ի հետ աշխատելու համար TestMace. Ինչու TestMace? Համեմատած նմանատիպ ապրանքների հետ՝ այն ունի հետևյալ առավելությունները.

• հզոր աշխատանք փոփոխականների հետ: Այս պահին կան փոփոխականների մի քանի տեսակներ, որոնցից յուրաքանչյուրը որոշակի դեր է խաղում՝ ներկառուցված փոփոխականներ, դինամիկ փոփոխականներ, միջավայրի փոփոխականներ։ Յուրաքանչյուր փոփոխական պատկանում է ժառանգության մեխանիզմին աջակցող հանգույցին.
• Հեշտությամբ ստեղծեք սցենարներ առանց ծրագրավորման: Սա կքննարկվի ստորև;
• մարդու համար ընթեռնելի ձևաչափ, որը թույլ է տալիս պահպանել նախագիծը տարբերակների կառավարման համակարգերում.
• ավտոմատ լրացում, շարահյուսության ընդգծում, փոփոխական արժեքի ընդգծում;
• API նկարագրության աջակցություն՝ Swagger-ից ներմուծելու ունակությամբ:

Եկեք սկսենք մեր սերվերը հրամանով npm start և փորձեք մուտք գործել օգտվողների ցանկ: Օգտատերերի ցանկը, դատելով մեր վերահսկիչի կազմաձևից, կարելի է ստանալ url localhost:3000/users-ից: Եկեք հարցում կատարենք այս url-ին:
TestMace-ը գործարկելուց հետո դուք կարող եք տեսնել այսպիսի ինտերֆեյս.

Վերևի ձախ մասում նախագծի ծառն է՝ արմատային հանգույցով Նախագիծ. Փորձենք ստեղծել առաջին հարցումը՝ օգտատերերի ցուցակ ստանալու համար։ Դրա համար մենք կստեղծենք RequestStep հանգույց Դա արվում է Ծրագրի հանգույցի համատեքստային մենյուում Ավելացնել հանգույց -> RequestStep.

URL դաշտում տեղադրեք localhost:3000/users և գործարկեք հարցումը: Մենք կստանանք 200 կոդը՝ պատասխան մարմնում դատարկ զանգվածով: Հասկանալի է, մենք դեռ ոչ ոքի չենք ավելացրել։
Եկեք ստեղծենք սցենար, որը կներառի հետևյալ քայլերը.

1. օգտվողի ստեղծում;
2. նորաստեղծ օգտագործողի id-ի հարցում.
3. ջնջում 1-ին քայլում ստեղծված օգտվողի ID-ով:

Այսպիսով, եկեք գնանք: Հարմարության համար եկեք ստեղծենք նման հանգույց Թղթապանակ. Ըստ էության, սա ընդամենը թղթապանակ է, որտեղ մենք կպահենք ամբողջ սցենարը: Թղթապանակի հանգույց ստեղծելու համար հանգույցի համատեքստային ընտրացանկից ընտրեք Նախագիծ Ավելացնել հանգույց -> Թղթապանակ. Եկեք կոչենք հանգույցը ստուգում-ստեղծում. Հանգույցի ներսում ստուգում-ստեղծում Եկեք ստեղծենք մեր առաջին հայտը՝ օգտատեր ստեղծելու համար: Անվանենք նորաստեղծ հանգույցը ստեղծել-օգտագործող. Այսինքն, այս պահին հանգույցի հիերարխիան այսպիսի տեսք կունենա.

Եկեք գնանք բաց ներդիր ստեղծել-օգտագործող հանգույց. Հարցման համար մուտքագրենք հետևյալ պարամետրերը.

• Հարցման տեսակը՝ ՓՈՍՏ
• URL - localhost:3000/users
• Մարմին - JSON արժեքով {"email": "[email protected]", "displayName": "New user", "username": "user"}

Կատարենք այս խնդրանքը։ Մեր հավելվածում ասվում է, որ ձայնագրությունը ստեղծվել է։

Դե, եկեք ստուգենք այս փաստը: Հետագա քայլերում ստեղծված օգտագործողի ID-ով գործելու համար այս պարամետրը պետք է պահպանվի: Մեխանիզմը կատարյալ է դրա համար: դինամիկ փոփոխականներ. Եկեք մեր օրինակով նայենք, թե ինչպես աշխատել նրանց հետ: Պատասխանի վերլուծված ներդիրում, համատեքստի ընտրացանկի id հանգույցի կողքին, ընտրեք տարրը Նշանակել փոփոխականին. Երկխոսության վանդակում դուք պետք է սահմանեք հետևյալ պարամետրերը.

• Հանգույց — նախնիներից որում ստեղծել դինամիկ փոփոխական: Եկեք ընտրենք ստուգում-ստեղծում
• Փոփոխական անուն - այս փոփոխականի անվանումը: Եկեք զանգենք userId.

Ահա թե ինչ տեսք ունի դինամիկ փոփոխական ստեղծելու գործընթացը.

Այժմ, ամեն անգամ, երբ այս հարցումը կատարվում է, դինամիկ փոփոխականի արժեքը կթարմացվի: Եվ քանի որ դինամիկ փոփոխականները աջակցում են հիերարխիկ ժառանգության մեխանիզմին, փոփոխական userId հասանելի կլինի ժառանգներով ստուգում-ստեղծում ցանկացած բույնի մակարդակի հանգույց:
Այս փոփոխականը մեզ օգտակար կլինի հաջորդ հարցում: Մասնավորապես, մենք կպահանջենք նորաստեղծ օգտագործողին։ Որպես հանգույցի երեխա ստուգում-ստեղծում մենք կստեղծենք հարցում ստուգում, եթե գոյություն ունի պարամետրով url հավասար localhost:3000/users/${$dynamicVar.userId}. Դիտել դիզայնը ${variable_name} սա փոփոխականի արժեք է ստանում: Որովհետեւ Մենք ունենք դինամիկ փոփոխական, ուստի այն ստանալու համար անհրաժեշտ է մուտք գործել օբյեկտ $dynamicVar, այսինքն՝ ամբողջությամբ մուտք գործել դինամիկ փոփոխական userId այսպիսի տեսք կունենա ${$dynamicVar.userId}. Եկեք կատարենք հարցումը և համոզվենք, որ տվյալները ճիշտ են պահանջվում։
Մնացած վերջին քայլը ջնջման պահանջն է: Մեզ դա պետք է ոչ միայն ջնջման գործողությունը ստուգելու, այլ նաև, այսպես ասած, տվյալների բազայում մեր հետևից մաքրելու համար, քանի որ. Էլփոստի և օգտվողի անվան դաշտերը եզակի են: Այսպիսով, check-create հանգույցում մենք կստեղծենք delete-user հարցում հետևյալ պարամետրերով

• Հարցման տեսակը - ՋՆՋԵԼ
• URL - localhost:3000/users/${$dynamicVar.userId}

Եկեք գործարկենք. Մենք սպասում ենք. Մենք վայելում ենք արդյունքը)

Դե, հիմա մենք կարող ենք ցանկացած պահի գործարկել այս ամբողջ սցենարը: Սցենարը գործարկելու համար անհրաժեշտ է ընտրել համատեքստի ընտրացանկից ստուգում-ստեղծում հանգույցի տարր Վազում.

Սցենարում գտնվող հանգույցները կկատարվեն մեկը մյուսի հետևից
Դուք կարող եք այս սկրիպտը պահել ձեր նախագծում՝ գործարկելով Ֆայլ -> Պահպանել նախագիծը.

Ամփոփում

Օգտագործված գործիքների բոլոր հատկանիշները պարզապես չէին կարող տեղավորվել այս հոդվածի ձևաչափի մեջ: Ինչ վերաբերում է գլխավոր մեղավորին՝ փաթեթին լաբիրինթոսjsx/crud - հետևյալ թեմաները մնում են բացահայտ.

• մոդելների մաքսային վավերացում և վերափոխում;
• հարցումների հզոր լեզու և դրա հարմար օգտագործումը առջևում;
• վերասահմանում և նոր մեթոդների ավելացում անմշակ կարգավորիչներին.
• գայթակղիչ աջակցություն;
• քեշավորման կառավարում.

Այնուամենայնիվ, նույնիսկ այն, ինչ նկարագրված է հոդվածում, բավական է հասկանալու համար, որ նույնիսկ այնպիսի ձեռնարկության շրջանակը, ինչպիսին NestJS-ն է, ունի կիրառման արագ նախատիպավորման գործիքներ։ Եվ նման թույն IDE-ի նման TestMace թույլ է տալիս պահպանել որոշակի տեմպ:

Այս հոդվածի սկզբնական կոդը՝ նախագծի հետ միասին TestMace, հասանելի է պահոցում https://github.com/TestMace/nest-rest. Նախագիծ բացելու համար TestMace պարզապես դա արեք հավելվածում Ֆայլ -> Բացել նախագիծը.

Source: www.habr.com