Nest، @nestjsx/crud ۽ TestMace سان تڪڙو CRUD ٺاھڻ

Nest، @nestjsx/crud ۽ TestMace سان تڪڙو CRUD ٺاھڻ

في الحال، REST API ويب ايپليڪيشن ڊولپمينٽ لاءِ هڪ معيار بڻجي چڪو آهي، ترقي کي آزاد حصن ۾ ورهائڻ جي اجازت ڏئي ٿو. مختلف مشهور فريم ورڪ جهڙوڪ Angular، React، Vue ۽ ٻيا في الحال UI لاءِ استعمال ٿين ٿا. پس منظر ڊولپرز مختلف ٻولين ۽ فريم ورڪ مان چونڊي سگھن ٿا. اڄ مان اهڙي فريم ورڪ بابت ڳالهائڻ چاهيندس جيئن NestJS. اسان اندر آهيون ٽيسٽ ميس اسان ان کي فعال طور تي اندروني منصوبن لاء استعمال ڪندا آهيون. Nest ۽ پيڪيج استعمال ڪندي @nestjsx/crud، اسان هڪ سادي CRUD ايپليڪيشن ٺاهينداسين.

ڇو NestJS

تازو، جاوا اسڪرپٽ ڪميونٽي ۾ ڪافي پس منظر فريم ورڪ ظاهر ٿيا آهن. ۽ جيڪڏهن ڪارڪردگي جي لحاظ کان اهي Nest کي ساڳي صلاحيتون مهيا ڪن ٿا، پوء هڪ شيء ۾ اهو ضرور کٽندو آهي - هي فن تعمير آهي. هيٺيون NestJS خاصيتون توهان کي صنعتي ايپليڪيشنون ٺاهڻ ۽ وڏي ٽيمن جي پيماني تي ترقي جي اجازت ڏين ٿيون:

  • TypeScript استعمال ڪندي بنيادي ترقي واري ٻولي طور. جيتوڻيڪ NestJS JavaScript کي سپورٽ ڪري ٿو، ڪجهه ڪارڪردگي ڪم نه ڪري سگھي ٿي، خاص طور تي جيڪڏهن اسان ٽئين پارٽي پيڪيجز بابت ڳالهائي رهيا آهيون؛
  • هڪ DI ڪنٽينر جي موجودگي، جيڪا توهان کي آساني سان جوڙيل اجزاء ٺاهڻ جي اجازت ڏئي ٿي؛
  • فريم ورڪ جي ڪارڪردگي پاڻ کي آزاد مٽائيندڙ اجزاء ۾ ورهايل آهي. مثال طور، هود جي تحت هڪ فريم ورڪ جي طور تي ان کي استعمال ڪري سگهجي ٿو ظاهر ڪيو، ۽ تيز ڪرڻ، ڊيٽابيس سان ڪم ڪرڻ لاءِ، باڪس کان ٻاهر نڪتل بائنڊنگ مهيا ڪري ٿي ٽائپفارم, مڪن جو, ترتيب ڏيڻ;
  • NestJS پليٽ فارم agnostic آهي ۽ سپورٽ ڪري ٿو REST، GraphQL، Websockets، gRPC وغيره.

فريم ورڪ پاڻ کي Angular فرنٽ اينڊ فريم ورڪ کان متاثر ڪيو ويو آهي ۽ تصوراتي طور تي ان سان تمام گهڻو عام آهي.

NestJS انسٽال ڪرڻ ۽ پروجيڪٽ کي ترتيب ڏيڻ

Nest هڪ پيڪيج تي مشتمل آهي نذر/cli، جيڪو توهان کي جلدي هڪ بنيادي ايپليڪيشن فريم ورڪ کي ترتيب ڏيڻ جي اجازت ڏئي ٿو. اچو ته هن پيڪيج کي عالمي سطح تي انسٽال ڪريون:

npm install --global @nest/cli

تنصيب کان پوء، اسان نالي سان اسان جي ايپليڪيشن جو بنيادي فريم ورڪ ٺاهينداسين 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 طور. ذوق جي باري ۾ ڪو به تڪرار ناهي؛ منهنجي خيال ۾، اهو سڀ کان وڌيڪ بالغ ڊي بي ايم ايس آهي، جنهن ۾ تمام ضروري صلاحيتون آهن. جيئن اڳ ۾ ئي ذڪر ڪيو ويو آهي، Nest ڊيٽابيس سان ڪم ڪرڻ لاء مختلف پيڪيجز سان انضمام مهيا ڪري ٿو. ڇاڪاڻ ته جيئن ته منهنجي پسند PostgreSQL تي آئي، اهو منطقي هوندو ته TypeORM کي ORM طور چونڊيو وڃي. اچو ته ڊيٽابيس سان انضمام لاءِ ضروري پيڪيجز انسٽال ڪريون:

yarn add typeorm @nestjs/typeorm pg

ترتيب ۾، هر پيڪيج جي ڪهڙي ضرورت آهي:

  1. typeorm - هڪ پيڪيج سڌو سنئون ORM کان پاڻ؛
  2. @nestjs/typeorm - TypeORM پيڪيج NestJS لاءِ. پراجيڪٽ جي ماڊلز ۾ درآمد ڪرڻ لاءِ ماڊلز شامل ڪري ٿو، ۽ گڏوگڏ مددگار سينگار جو ھڪڙو سيٽ؛
  3. pg - ڊرائيور PostgreSQL سان ڪم ڪرڻ لاء.

ٺيڪ آهي، پيڪيجز انسٽال ٿيل آهن، هاڻي توهان کي ڊيٽابيس کي لانچ ڪرڻو پوندو. ڊيٽابيس کي ترتيب ڏيڻ لاءِ، مان استعمال ڪندس docker-compose.yml هيٺين مواد سان:

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"
}
}

هي تشڪيل استعمال ڪيو ويندو ڪلائي ٽائپورم لاءِ.

اچو ته هن ترتيب کي وڌيڪ تفصيل سان ڏسو. سٽون 3 ۽ 4 تي اسان ماحوليات جي متغيرن مان صارف جو نالو ۽ پاسورڊ حاصل ڪندا آهيون. اهو آسان آهي جڏهن توهان وٽ ڪيترائي ماحول آهن (ديو، اسٽيج، پروڊ، وغيره). ڊفالٽ طور، صارف جو نالو پوسٽ گريس آهي ۽ پاسورڊ مثال آهي. باقي ٺاھ جوڙ ننڍڙو آھي، تنھنڪري اسان صرف سڀ کان وڌيڪ دلچسپ پيٽرولن تي ڌيان ڏينداسين:

  • هم وقت سازي - ظاهر ڪري ٿو ته ڇا ڊيٽابيس اسڪيما خودڪار طريقي سان ٺاهيو وڃي جڏهن ايپليڪيشن شروع ٿئي. ھن اختيار سان محتاط رھو ۽ ان کي پيداوار ۾ استعمال نه ڪريو، ٻي صورت ۾ توھان ڊيٽا وڃائي ويندؤ. هي اختيار آسان آهي جڏهن هڪ ايپليڪيشن کي ترقي ۽ ڊيبگ ڪرڻ. ھن اختيار جي متبادل طور، توھان استعمال ڪري سگھو ٿا حڪم schema:sync CLI TypeORM کان.
  • dropSchema - اسڪيما کي ري سيٽ ڪريو هر وقت ڪنيڪشن قائم ڪيو وڃي. بس پوئين هڪ وانگر، هي اختيار صرف ايپليڪيشن جي ترقي ۽ ڊيبگنگ دوران استعمال ڪيو وڃي.
  • ادارا - ماڊل جي وضاحت لاءِ ڪهڙا رستا. مهرباني ڪري نوٽ ڪريو ته ماسڪ ذريعي ڳولا جي حمايت ڪئي وئي آهي.
  • cli.entitiesDir اها ڊاريڪٽري آهي جتي ماڊل TypeORM CLI مان ٺاهيل ڊفالٽ طور محفوظ ڪيا وڃن.

اسان جي Nest ايپليڪيشن ۾ TypeORM جون سڀئي خاصيتون استعمال ڪرڻ جي قابل ٿيڻ لاءِ، اسان کي ماڊيول درآمد ڪرڻو پوندو 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 جاوا اسڪرپٽ ۾ لکيل آهي ۽ نوڊج ماحول ۾ هلندو آهي. بهرحال، اسان جا سڀئي ماڊل ۽ لڏپلاڻ ٽائيپ اسڪرپٽ ۾ لکيل هونديون. تنهن ڪري، CLI استعمال ڪرڻ کان پهريان اسان جي لڏپلاڻ ۽ ماڊل کي منتقل ڪرڻ ضروري آهي. ان لاءِ اسان کي ts-node پيڪيج جي ضرورت آھي:

yarn add -D ts-node

ان کان پوء، ضروري حڪمن کي شامل ڪريو package.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 شامل ڪري ٿو. باقي حڪم آسان شارٽ ڪٽ آهن جيڪي توهان، هڪ ڊولپر جي حيثيت ۾، تقريبا هر روز استعمال ڪندا:
migration:generate - توهان جي ماڊل ۾ تبديلين جي بنياد تي لڏپلاڻ ٺاهڻ.
migration:create - هڪ خالي لڏپلاڻ ٺاهڻ.
migration:run - لڏپلاڻ شروع ڪرڻ.
خير، اهو هاڻي آهي، اسان ضروري پيڪيجز شامل ڪيا آهن، ايپليڪيشن کي ترتيب ڏنو آهي ڊيٽابيس سان گڏ ڪم ڪرڻ لاءِ ٻنهي ڪلائي ۽ ايپليڪيشن کان، ۽ پڻ لانچ ڪيو DBMS. اهو اسان جي ايپليڪيشن ۾ منطق شامل ڪرڻ جو وقت آهي.

CRUD ٺاهڻ لاءِ پيڪيجز کي انسٽال ڪرڻ

صرف Nest استعمال ڪندي، توهان هڪ API ٺاهي سگهو ٿا جيڪو توهان کي هڪ ادارو ٺاهڻ، پڙهڻ، اپڊيٽ ڪرڻ ۽ حذف ڪرڻ جي اجازت ڏئي ٿو. اهو حل ممڪن طور تي لچڪدار هوندو، پر ڪجهه حالتن ۾ اهو بيڪار ٿيندو. مثال طور، جيڪڏهن توهان کي جلدي هڪ پروٽوٽائپ ٺاهڻ جي ضرورت آهي، توهان اڪثر ڪري ترقي جي رفتار لاء لچڪدار قرباني ڪري سگهو ٿا. ڪيترائي فريم ورڪ CRUD پيدا ڪرڻ لاءِ ڪارڪردگي مهيا ڪن ٿا ھڪڙي خاص اداري جي ڊيٽا ماڊل کي بيان ڪندي. ۽ Nest ڪو به استثنا نه آهي! هي ڪارڪردگي پيڪيج طرفان مهيا ڪيل آهي @nestjsx/crud. ان جون صلاحيتون تمام دلچسپ آهن:

  • آسان تنصيب ۽ تشڪيل؛
  • DBMS آزادي؛
  • طاقتور سوال ٻولي فلٽر ڪرڻ جي صلاحيت سان، صفحي کي ترتيب ڏيڻ، ترتيب ڏيڻ، لوڊ رشتي ۽ nested ادارن، ڪيشنگ، وغيره.
  • فرنٽ-آخر تي درخواستون پيدا ڪرڻ لاءِ پيڪيج؛
  • ڪنٽرولر طريقن جي آسان overriding؛
  • ننڍي جوڙجڪ؛
  • 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 مان ڪلائي استعمال ڪريون ۽ اسان جي پروجيڪٽ جي روٽ ڊاريڪٽري ۾ ڪمانڊ کي عمل ۾ آڻيون 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)

هن ماڊل ۾ اسان هڪ اينٽيٽيز فولڊر شامل ڪنداسين، جتي اسان وٽ هن ماڊل جا ماڊل هوندا. خاص طور تي، اچو ته هتي شامل ڪريون 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 هيٺ ڏنل مواد:

user.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 مخزن.

user.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 ۾ هڪ سوال اسڪرپٽ ٺاهڻ

اسان جي خدمت کي جانچڻ لاءِ اسان API سان ڪم ڪرڻ لاءِ IDE استعمال ڪنداسين ٽيسٽ ميس. TestMace ڇو؟ ساڳئي شين جي مقابلي ۾، ان جا هيٺيان فائدا آهن:

  • variables سان طاقتور ڪم. هن وقت، متغير جا ڪيترائي قسم آهن، جن مان هر هڪ هڪ خاص ڪردار ادا ڪري ٿو: بلٽ ان متغير، متحرڪ متغير، ماحولياتي متغير. هر متغير هڪ نوڊ سان تعلق رکي ٿو وراثت واري ميڪانيزم جي حمايت سان؛
  • پروگرامنگ کان سواءِ آساني سان اسڪرپٽ ٺاهيو. هن هيٺ بحث ڪيو ويندو؛
  • انساني پڙهڻ جي قابل فارميٽ جيڪا توهان کي پروجيڪٽ کي ورزن ڪنٽرول سسٽم ۾ محفوظ ڪرڻ جي اجازت ڏئي ٿي؛
  • خودڪار مڪمل ڪرڻ، نحو نمايان ڪرڻ، متغير قدر نمايان ڪرڻ؛
  • API وضاحت سپورٽ سوگر مان درآمد ڪرڻ جي صلاحيت سان.

اچو ته اسان جي سرور کي حڪم سان شروع ڪريون npm start ۽ استعمال ڪندڙن جي فهرست تائين رسائي حاصل ڪرڻ جي ڪوشش ڪريو. صارفين جي فهرست، اسان جي ڪنٽرولر ترتيب جي ترتيب سان، حاصل ڪري سگھجي ٿو url localhost:3000/users. اچو ته هن url تي هڪ درخواست ڪريون.
TestMace هلائڻ کان پوء توهان هن طرح هڪ انٽرفيس ڏسي سگهو ٿا:

Nest، @nestjsx/crud ۽ TestMace سان تڪڙو CRUD ٺاھڻ

مٿي کاٻي پاسي هڪ پروجيڪٽ وڻ آهي جيڪو روٽ نوڊ سان پروجيڪٽ. اچو ته پهرين درخواست ٺاهڻ جي ڪوشش ڪريون صارفين جي لسٽ حاصل ڪرڻ لاءِ. ان لاءِ اسان ٺاهينداسين درخواست جو مرحلو نوڊ اهو پروجيڪٽ نوڊ جي حوالي سان مينيو ۾ ڪيو ويندو آهي شامل ڪريو نوڊ -> RequestStep.

Nest، @nestjsx/crud ۽ TestMace سان تڪڙو CRUD ٺاھڻ

URL فيلڊ ۾، پيسٽ ڪريو localhost:3000/users ۽ درخواست کي هلائي. اسان حاصل ڪنداسين ڪوڊ 200 جوابي جسم ۾ خالي صف سان. اهو سمجھڻ وارو آهي، اسان اڃا تائين ڪنهن کي شامل نه ڪيو آهي.
اچو ته هڪ اسڪرپٽ ٺاهيو جنهن ۾ هيٺيان قدم شامل هوندا.

  1. صارف ٺاهڻ؛
  2. نئين ٺاهيل صارف جي سڃاڻپ لاء درخواست؛
  3. قدم 1 ۾ ٺاهيل صارف جي سڃاڻپ ذريعي ختم ڪرڻ.

سو، اچو ته هلون. سهولت لاء، اچو ته هڪ نوڊ ٺاهيو فولڊر. لازمي طور تي، هي صرف هڪ فولڊر آهي جنهن ۾ اسان سڄي اسڪرپٽ کي محفوظ ڪنداسين. فولڊر نوڊ ٺاھڻ لاءِ، نوڊ جي ڪنٽيڪٽ مينيو مان پروجيڪٽ چونڊيو شامل ڪريو نوڊ -> فولڊر. اچو ته نوڊ کي سڏين چيڪ ٺاهڻ. هڪ نوڊ اندر چيڪ ٺاهڻ اچو ته اسان جي پهرين درخواست ٺاهي يوزر ٺاهڻ لاءِ. اچو ته نئين ٺاهيل نوڊ کي سڏين ٺاھيندڙ استعمال ڪندڙ. اهو آهي، هن وقت نوڊ جي جوڙجڪ هن طرح نظر ايندي:

Nest، @nestjsx/crud ۽ TestMace سان تڪڙو CRUD ٺاھڻ

اچو ته کليل ٽيب ڏانهن وڃو ٺاھيندڙ استعمال ڪندڙ نوڊ. اچو ته درخواست لاء ھيٺ ڏنل پيٽرولر داخل ڪريو:

  • درخواست جو قسم - پوسٽ
  • URL - localhost: 3000 / استعمال ڪندڙ
  • جسم - JSON قدر سان {"email": "[email protected]", "displayName": "New user", "username": "user"}

اچو ته اها درخواست پوري ڪريون. اسان جي درخواست جو چوڻ آهي ته رڪارڊ ٺاهيو ويو آهي.

Nest، @nestjsx/crud ۽ TestMace سان تڪڙو CRUD ٺاھڻ

خير، اچو ته هن حقيقت جي جانچ ڪريون. ايندڙ مرحلن ۾ ٺاهيل استعمال ڪندڙ جي id سان ڪم ڪرڻ لاء، هي پيٽرولر محفوظ ڪيو وڃي. ميڪانيزم هن لاء ڀرپور آهي. متحرڪ variables. اچو ته اسان جو مثال استعمال ڪريون ته ڏسو ته انهن سان ڪيئن ڪم ڪجي. جواب جي parsed ٽيب ۾، id node جي اڳيان، context menu ۾، شيون چونڊيو متغير کي مقرر ڪريو. ڊائلاگ باڪس ۾ توھان کي ھيٺ ڏنل پيرا ميٽر مقرر ڪرڻ گھرجي.

  • نوڊ - جنهن ۾ ابن ڏاڏن مان هڪ متحرڪ متغير ٺاهڻ لاء. اچو ته چونڊيو چيڪ ٺاهڻ
  • قابل نالو - هن متغير جو نالو. اچو ته سڏين userId.

ھتي آھي ھڪڙو متحرڪ متغير ٺاھڻ جو عمل جھڙو آھي:

Nest، @nestjsx/crud ۽ TestMace سان تڪڙو CRUD ٺاھڻ

ھاڻي، ھر دفعي ھن سوال تي عمل ڪيو ويندو، متحرڪ متغير جو قدر اپڊيٽ ڪيو ويندو. ۽ ڇاڪاڻ ته متحرڪ variables hierarchical وراثت جي ميڪانيزم جي حمايت ڪن ٿا، variable userId اولاد ۾ موجود هوندو چيڪ ٺاهڻ ڪنهن به nesting سطح جو node.
هي variable ايندڙ درخواست ۾ اسان لاء مفيد ٿيندو. يعني، اسان نئين ٺاهيل صارف جي درخواست ڪنداسين. جيئن ته هڪ نوڊ جي ٻار چيڪ ٺاهڻ اسان هڪ درخواست ٺاهينداسين چيڪ-جيڪڏهن موجود آهي پيٽرولر سان url برابر localhost:3000/users/${$dynamicVar.userId}. ڊيزائن ڏسو ${variable_name} هي هڪ متغير جي قيمت حاصل ڪري رهيو آهي. ڇاڪاڻ ته اسان وٽ هڪ متحرڪ متغير آهي، تنهنڪري ان کي حاصل ڪرڻ لاء توهان کي اعتراض تائين رسائي جي ضرورت آهي $dynamicVar، يعني مڪمل طور تي هڪ متحرڪ متغير تائين رسائي userId هن طرح نظر ايندي ${$dynamicVar.userId}. اچو ته درخواست تي عمل ڪريو ۽ پڪ ڪريو ته ڊيٽا صحيح طور تي درخواست ڪئي وئي آهي.
آخري قدم ڇڏي ويو آهي حذف ڪرڻ جي درخواست ڪرڻ. اسان کي اها ضرورت آهي ته نه رڳو حذف ڪرڻ جي عمل کي جانچڻ لاءِ، پر انهي سان گڏ ڳالهائڻ لاءِ، ڊيٽابيس ۾ پاڻ کي صاف ڪرڻ لاءِ، ڇاڪاڻ ته. اي ميل ۽ صارف نام جا شعبا منفرد آهن. تنهن ڪري، چيڪ-ڪيٽ نوڊ ۾ اسان ٺاهينداسين حذف-يوزر جي درخواست هيٺ ڏنل پيٽرولن سان

  • درخواست جو قسم - DELETE
  • URL - localhost:3000/users/${$dynamicVar.userId}

اچو ته لانچ ڪريون. اسان انتظار ڪريون ٿا. اسان نتيجو مزو وٺون ٿا)

خير، هاڻي اسان هن سڄي اسڪرپٽ کي ڪنهن به وقت هلائي سگهون ٿا. اسڪرپٽ کي هلائڻ لاءِ توھان کي منتخب ڪرڻ جي ضرورت آھي ڪنٽيڪيٽ مينيو مان چيڪ ٺاهڻ نوڊ آئٽم هل.

Nest، @nestjsx/crud ۽ TestMace سان تڪڙو CRUD ٺاھڻ

اسڪرپٽ ۾ نوڊس هڪ ٻئي کان پوء جاري ڪيا ويندا
توھان ھلائي سگھوٿا ھن اسڪرپٽ کي پنھنجي پروجيڪٽ ۾ فائل -> پروجيڪٽ محفوظ ڪريو.

ٿڪل

استعمال ٿيل اوزارن جون سڀئي خاصيتون هن مضمون جي شڪل ۾ نه ٿي سگهيون. جيئن ته مکيه مجرم لاء - پيڪيج نذرjsx/crud - ھيٺيون موضوع بي نقاب رھيا آھن:

  • ڪسٽم جي تصديق ۽ ماڊلز جي تبديلي؛
  • طاقتور سوال ٻولي ۽ ان جو آسان استعمال اڳيان؛
  • crud ڪنٽرولرز کي نئين طريقن کي ٻيهر بيان ڪرڻ ۽ شامل ڪرڻ؛
  • swagger حمايت؛
  • ڪيشنگ جو انتظام.

تنهن هوندي به، مضمون ۾ جيڪو بيان ڪيو ويو آهي، اهو سمجهڻ لاء ڪافي آهي ته جيتوڻيڪ هڪ اهڙي ادارتي فريم ورڪ جيئن NestJS تيز ايپليڪيشن پروٽو ٽائپنگ لاء اوزار آهي. ۽ اهڙي ٿڌي IDE وانگر ٽيسٽ ميس توهان کي ڏنل رفتار برقرار رکڻ جي اجازت ڏئي ٿي.

ھن مضمون لاء ماخذ ڪوڊ، منصوبي سان گڏ ٽيسٽ ميس، مخزن ۾ موجود https://github.com/TestMace/nest-rest. پروجيڪٽ کولڻ لاءِ ٽيسٽ ميس صرف ايپ ۾ ڪريو فائل -> اوپن پروجيڪٽ.

جو ذريعو: www.habr.com

تبصرو شامل ڪريو