Yara CRUD ẹda pẹlu itẹ-ẹiyẹ, @nestjsx/crud ati TestMace

Yara CRUD ẹda pẹlu itẹ-ẹiyẹ, @nestjsx/crud ati TestMace

Lọwọlọwọ, API REST ti di idiwọn fun idagbasoke ohun elo wẹẹbu, gbigba idagbasoke lati pin si awọn ẹya ominira. Orisirisi awọn ilana olokiki bii Angular, React, Vue ati awọn miiran lo lọwọlọwọ fun UI. Awọn olupilẹṣẹ afẹyinti le yan lati ọpọlọpọ awọn ede ati awọn ilana. Loni Emi yoo fẹ lati sọrọ nipa iru ilana bii NestJS. A wa ninu TestMace A lo o fun awọn iṣẹ inu inu. Lilo itẹ-ẹiyẹ ati package @nestjsx/crud, a yoo ṣẹda ohun elo CRUD ti o rọrun.

Kí nìdí NestJS

Laipẹ, ọpọlọpọ awọn ilana ẹhin ti han ni agbegbe JavaScript. Ati pe ti o ba jẹ pe ni awọn ofin ti iṣẹ ṣiṣe wọn pese awọn agbara iru si itẹ-ẹiyẹ, lẹhinna ninu ohun kan o ṣẹgun dajudaju - eyi ni faaji. Awọn ẹya NestJS atẹle yii gba ọ laaye lati ṣẹda awọn ohun elo ile-iṣẹ ati idagbasoke iwọn si awọn ẹgbẹ nla:

  • lilo TypeScript gẹgẹbi ede idagbasoke akọkọ. Botilẹjẹpe NestJS ṣe atilẹyin JavaScript, diẹ ninu awọn iṣẹ ṣiṣe le ma ṣiṣẹ, paapaa ti a ba n sọrọ nipa awọn idii ẹnikẹta;
  • wiwa ti eiyan DI kan, eyiti o fun ọ laaye lati ṣẹda awọn paati ti o ni idapọmọra lainidi;
  • Iṣẹ ṣiṣe ti ilana funrararẹ ti pin si awọn paati interchangeable ominira. Fun apẹẹrẹ, labẹ awọn Hood bi a ilana o le ṣee lo bi han, ati fastify, lati ṣiṣẹ pẹlu awọn database, itẹ-ẹiyẹ jade kuro ninu apoti pese awọn abuda si oriṣi, mongoose, sequelize;
  • NestJS jẹ agnostic Syeed ati atilẹyin REST, GraphQL, Websockets, gRPC, ati bẹbẹ lọ.

Ilana naa funrararẹ ni atilẹyin nipasẹ ilana iwaju Angular ati ni imọran ni ọpọlọpọ ni wọpọ pẹlu rẹ.

Fifi NestJS sori ẹrọ ati Gbigbe Ise agbese na

Nest ni idii kan ninu itẹ-ẹiyẹ/ cli, eyiti o fun ọ laaye lati yara fi eto ohun elo ipilẹ kan ranṣẹ. Jẹ ki a fi package yii sori ẹrọ ni agbaye:

npm install --global @nest/cli

Lẹhin fifi sori ẹrọ, a yoo ṣe agbekalẹ ilana ipilẹ ti ohun elo wa pẹlu orukọ itẹ-ẹiyẹ-rest. Eyi ni a ṣe nipa lilo aṣẹ naa nest new nest-rest.

itẹ-ẹiyẹ titun itẹ-isinmi

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

A yoo yan owu bi oluṣakoso package wa.
Ni aaye yii o le bẹrẹ olupin pẹlu aṣẹ naa npm start ati lilọ si adirẹsi http://localhost:3000 o le wo oju-iwe akọkọ. Sibẹsibẹ, eyi kii ṣe idi ti a fi pejọ nibi ati pe a nlọ siwaju.

Ṣiṣeto iṣẹ pẹlu database

Mo yan PostrgreSQL bi DBMS fun nkan yii. Ko si ariyanjiyan nipa awọn ohun itọwo; ninu ero mi, eyi ni DBMS ti o dagba julọ, ti o ni gbogbo awọn agbara pataki. Gẹgẹbi a ti sọ tẹlẹ, Nest n pese iṣọpọ pẹlu ọpọlọpọ awọn idii lati ṣiṣẹ pẹlu awọn apoti isura data. Nitori Niwọn igba ti yiyan mi ṣubu lori PostgreSQL, yoo jẹ ọgbọn lati yan TypeORM bi ORM kan. Jẹ ki a fi sori ẹrọ awọn idii pataki fun isọpọ pẹlu data data:

yarn add typeorm @nestjs/typeorm pg

Ni ibere, kini package kọọkan nilo fun:

  1. typeorm - package taara lati ORM funrararẹ;
  2. @nestjs/typeorm - package TypeORM fun NestJS. Ṣe afikun awọn modulu fun gbigbe wọle sinu awọn modulu iṣẹ akanṣe, bakanna bi ṣeto awọn oluranlọwọ oluranlọwọ;
  3. pg - awakọ fun ṣiṣẹ pẹlu PostgreSQL.

O dara, awọn idii ti fi sori ẹrọ, ni bayi o nilo lati ṣe ifilọlẹ data funrararẹ. Lati ran ibi ipamọ data lọ, Emi yoo lo docker-compose.yml pẹlu akoonu wọnyi:

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

Bii o ti le rii, faili yii tunto ifilọlẹ ti awọn apoti 2:

  1. db jẹ eiyan taara ti o ni aaye data ninu. Ninu ọran wa, ikede postgresql 11.2 ti lo;
  2. alabojuto-database faili. Pese oju opo wẹẹbu kan fun wiwo ati iṣakoso data data.

Lati ṣiṣẹ pẹlu awọn asopọ tcp, Mo ṣafikun atunto atẹle naa.

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

Iyẹn ni gbogbo rẹ, o le bẹrẹ awọn apoti pẹlu aṣẹ naa docker-compose up -d. Tabi ni lọtọ console pẹlu pipaṣẹ docker-compose up.

Nitorinaa, awọn idii ti fi sori ẹrọ, a ti ṣe ifilọlẹ data data, gbogbo ohun ti o ku ni lati jẹ ki wọn jẹ ọrẹ pẹlu ara wọn. Lati ṣe eyi, o nilo lati ṣafikun faili atẹle si gbongbo ise agbese: 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"
}
}

Yi iṣeto ni yoo ṣee lo fun cli typeorm.

Jẹ ki a wo iṣeto yii ni awọn alaye diẹ sii. Lori awọn ila 3 ati 4 a gba orukọ olumulo ati ọrọigbaniwọle lati awọn oniyipada ayika. Eyi jẹ irọrun nigbati o ni ọpọlọpọ awọn agbegbe (dev, ipele, prod, ati bẹbẹ lọ). Nipa aiyipada, orukọ olumulo jẹ postgres ati ọrọ igbaniwọle jẹ apẹẹrẹ. Iyoku atunto jẹ ohun kekere, nitorinaa a yoo dojukọ nikan lori awọn aye ti o nifẹ julọ:

  • muṣiṣẹpọ – Tọkasi boya ero data data yẹ ki o ṣẹda laifọwọyi nigbati ohun elo ba bẹrẹ. Ṣọra pẹlu aṣayan yii ki o ma ṣe lo ni iṣelọpọ, bibẹẹkọ iwọ yoo padanu data. Aṣayan yii rọrun nigba idagbasoke ati ṣatunṣe ohun elo kan. Gẹgẹbi yiyan si aṣayan yii, o le lo aṣẹ naa schema:sync lati CLI TypeORM.
  • dropSchema - tun eto naa tunto ni gbogbo igba ti asopọ ba ti fi idi mulẹ. Gẹgẹ bi ọkan ti tẹlẹ, aṣayan yii yẹ ki o lo nikan lakoko idagbasoke ati n ṣatunṣe aṣiṣe ohun elo naa.
  • awọn nkan - awọn ọna wo fun awọn apejuwe ti awọn awoṣe. Jọwọ ṣe akiyesi pe wiwa nipasẹ iboju-boju jẹ atilẹyin.
  • cli.entitiesDir jẹ itọsọna nibiti awọn awoṣe ti a ṣẹda lati TypeORM CLI yẹ ki o wa ni ipamọ nipasẹ aiyipada.

Ni ibere fun wa lati ni anfani lati lo gbogbo awọn ẹya ti TypeORM ninu ohun elo Nest wa, a nilo lati gbe module naa wọle. TypeOrmModule в AppModule. Awon. tirẹ AppModule yoo dabi eyi:

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

Bi o ti le ṣe akiyesi, ọna naa forRoot iṣeto ni kanna fun ṣiṣẹ pẹlu awọn database ti wa ni ti o ti gbe bi ni ormconfig.ts faili

Ifọwọkan ikẹhin wa - ṣafikun ọpọlọpọ awọn iṣẹ ṣiṣe fun ṣiṣẹ pẹlu TypeORM ni package.json. Otitọ ni pe a kọ CLI ni JavaScript ati ṣiṣe ni agbegbe nodejs. Sibẹsibẹ, gbogbo awọn awoṣe wa ati awọn iṣiwa yoo wa ni kikọ sinu iruwewe. Nitorinaa, o jẹ dandan lati tan awọn iṣiwa ati awọn awoṣe wa ṣaaju lilo CLI. Fun eyi a nilo package ts-node:

yarn add -D ts-node

Lẹhin iyẹn, ṣafikun awọn aṣẹ pataki si 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"

Aṣẹ akọkọ, typeorm, ṣe afikun ohun elo ts-node lati ṣiṣẹ TypeORM cli. Awọn ofin ti o ku jẹ awọn ọna abuja irọrun ti iwọ, bi olupilẹṣẹ, yoo lo o fẹrẹ to lojoojumọ:
migration:generate - ṣiṣẹda awọn ijira da lori awọn ayipada ninu awọn awoṣe rẹ.
migration:create - ṣiṣẹda ohun ṣofo ijira.
migration:run - ifilọlẹ awọn migrations.
O dara, iyẹn ni bayi, a ti ṣafikun awọn idii pataki, tunto ohun elo lati ṣiṣẹ pẹlu data data mejeeji lati cli ati lati ohun elo funrararẹ, ati tun ṣe ifilọlẹ DBMS naa. O to akoko lati ṣafikun ọgbọn si ohun elo wa.

Fifi awọn idii fun ṣiṣẹda CRUD

Lilo Nest nikan, o le ṣẹda API ti o fun ọ laaye lati ṣẹda, ka, ṣe imudojuiwọn, ati paarẹ nkan kan. Ojutu yii yoo rọ bi o ti ṣee, ṣugbọn ni awọn igba miiran yoo jẹ laiṣe. Fun apẹẹrẹ, ti o ba nilo lati yara ṣẹda apẹrẹ kan, o le nigbagbogbo rubọ irọrun fun iyara idagbasoke. Ọpọlọpọ awọn ilana pese iṣẹ ṣiṣe fun ti ipilẹṣẹ CRUD nipa ṣiṣe apejuwe awoṣe data ti nkan kan. Ati itẹ-ẹiyẹ ni ko si sile! Iṣẹ-ṣiṣe yii ni a pese nipasẹ package @nestjsx/crud. Awọn agbara rẹ jẹ igbadun pupọ:

  • rọrun fifi sori ati iṣeto ni;
  • DBMS ominira;
  • Ede ibeere ti o lagbara pẹlu agbara lati ṣe àlẹmọ, paginate, too, awọn ibatan fifuye ati awọn nkan ti itẹ-ẹiyẹ, caching, ati bẹbẹ lọ;
  • package fun ti o npese ibeere lori ni iwaju-opin;
  • Iṣeduro irọrun ti awọn ọna iṣakoso;
  • kekere konfigi;
  • swagger iwe support.

Iṣẹ ṣiṣe ti pin si ọpọlọpọ awọn idii:

  • @nestjsx/crud - ipilẹ package ti ohun ọṣọ pese Crud() fun ipa ọna, iṣeto ni ati afọwọsi;
  • @nestjsx/crud-ìbéèrè - package kan ti o pese olupilẹṣẹ ibeere / parser fun lilo ni ẹgbẹ iwaju;
  • @nestjsx/crud-typeorm - package kan fun isọpọ pẹlu TypeORM, n pese iṣẹ ipilẹ TypeOrmCrudService pẹlu awọn ọna CRUD fun ṣiṣẹ pẹlu awọn nkan ninu ibi ipamọ data.

Ninu ikẹkọ yii a yoo nilo awọn idii itẹ-ẹiyẹjsx/crud ati itẹ-ẹiyẹjsx/crud-typeorm. Ni akọkọ, jẹ ki a fi wọn sii

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

Awọn akopọ kilasi-ayipada и kilasi-validator ninu ohun elo yii ni a nilo fun apejuwe asọye ti awọn ofin fun yiyipada awọn apẹẹrẹ awoṣe ati ijẹrisi awọn ibeere ti nwọle, lẹsẹsẹ. Awọn idii wọnyi wa lati ọdọ onkọwe kanna, nitorinaa awọn atọkun jẹ iru.

Taara imuse ti CRUD

A yoo gba atokọ ti awọn olumulo bi apẹẹrẹ apẹẹrẹ. Awọn olumulo yoo ni awọn aaye wọnyi: id, username, displayName, email. id - aaye ti o pọ si laifọwọyi, email и username - oto oko. O rọrun! Gbogbo ohun ti o ku ni lati ṣe imuse ero wa ni irisi ohun elo itẹ-ẹiyẹ kan.
Ni akọkọ o nilo lati ṣẹda module users, tani yoo jẹ iduro fun ṣiṣẹ pẹlu awọn olumulo. Jẹ ki a lo cli lati NestJS ki o si ṣiṣẹ aṣẹ naa ni itọsọna root ti iṣẹ akanṣe wa nest g module users.

itẹ-ẹiyẹ g module awọn olumulo

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)

Ninu module yii a yoo ṣafikun folda awọn nkan kan, nibiti a yoo ni awọn awoṣe ti module yii. Ni pataki, jẹ ki a ṣafikun nibi olumulo olumulo.entity.ts faili pẹlu apejuwe ti awoṣe olumulo:

olumulo.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;
}

Ni ibere fun awoṣe yii lati "ri" nipasẹ ohun elo wa, o jẹ dandan ni module UsersModule gbe wọle TypeOrmModule akoonu wọnyi:

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

Iyẹn ni, nibi a gbe wọle TypeOrmModule, nibiti bi paramita ọna forFeature A tọkasi akojọ kan ti awọn awoṣe jẹmọ si yi module.

Gbogbo ohun ti o ku ni lati ṣẹda nkan ti o baamu ni ibi ipamọ data. Ilana ijira ṣiṣẹ fun awọn idi wọnyi. Lati ṣẹda ijira ti o da lori awọn ayipada ninu awọn awoṣe, o nilo lati ṣiṣẹ aṣẹ naa npm run migration:generate -- CreateUserTable:

akole apanirun

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

A ko ni lati kọ ijira pẹlu ọwọ, ohun gbogbo ṣẹlẹ magically. Ṣe eyi kii ṣe iyanu! Sibẹsibẹ, kii ṣe gbogbo rẹ. Jẹ ki a wo faili ijira ti o ṣẹda:

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"`);
}
}

Bii o ti le rii, kii ṣe ọna fun ibẹrẹ iṣiwa nikan ni ipilẹṣẹ laifọwọyi, ṣugbọn tun ọna fun yiyi pada. Ikọja!
Gbogbo ohun ti o ku ni lati yi irin-ajo yii jade. Eyi ni a ṣe pẹlu aṣẹ atẹle:

npm run migration:run.

Iyẹn ni, ni bayi awọn iyipada ero ti lọ si ibi ipamọ data.
Nigbamii ti, a yoo ṣẹda iṣẹ kan ti yoo jẹ iduro fun ṣiṣẹ pẹlu awọn olumulo ati jogun rẹ lati TypeOrmCrudService. Ibi ipamọ ti nkan ti iwulo gbọdọ kọja si paramita ti oluṣe obi, ninu ọran wa User ibi ipamọ.

users.iṣẹ.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);
}
}

A yoo nilo iṣẹ yii ni oludari users. Lati ṣẹda oluṣakoso, tẹ sinu console nest g controller users/controllers/users

itẹ-ẹiyẹ g oludari awọn olumulo / olutona / olumulo

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)

Jẹ ki a ṣii oludari yii ki o ṣatunkọ rẹ lati ṣafikun idan kekere kan itẹ-ẹiyẹjsx/crud. Fun kilasi UsersController Jẹ ki a ṣafikun ohun ọṣọ bi eleyi:

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

Crud jẹ ohun ọṣọ ti o ṣe afikun si oludari awọn ọna pataki fun ṣiṣẹ pẹlu awoṣe. Iru awoṣe jẹ itọkasi ni aaye model.type ohun ọṣọ atunto.
Igbese keji ni lati ṣe imuse wiwo naa CrudController<User>. “Apejọ” koodu oludari dabi eyi:

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){}
}

Ati pe gbogbo rẹ ni! Bayi oludari ṣe atilẹyin gbogbo awọn iṣẹ ṣiṣe pẹlu awoṣe! Maṣe gbagbọ mi? Jẹ ki a gbiyanju ohun elo wa ni iṣe!

Ṣiṣẹda iwe afọwọkọ ibeere ni TestMace

Lati ṣe idanwo iṣẹ wa a yoo lo IDE lati ṣiṣẹ pẹlu API TestMace. Kini idi ti TestMace? Ti a ṣe afiwe pẹlu iru awọn ọja, o ni awọn anfani wọnyi:

  • iṣẹ agbara pẹlu awọn oniyipada. Ni akoko yii, awọn oriṣiriṣi oriṣiriṣi wa ti awọn oniyipada, ọkọọkan eyiti o ṣe ipa kan pato: awọn oniyipada ti a ṣe sinu, awọn oniyipada agbara, awọn oniyipada ayika. Oniyipada kọọkan jẹ ti ipade pẹlu atilẹyin fun ẹrọ iní;
  • Ni irọrun ṣẹda awọn iwe afọwọkọ laisi siseto. Eleyi yoo wa ni sísọ ni isalẹ;
  • ọna kika ti eniyan ti o jẹ ki o fipamọ iṣẹ naa ni awọn eto iṣakoso ẹya;
  • autocompletion, fifi sintasi, afihan iye iyipada;
  • Atilẹyin apejuwe API pẹlu agbara lati gbe wọle lati Swagger.

Jẹ ki a bẹrẹ olupin wa pẹlu aṣẹ naa npm start ati ki o gbiyanju lati wọle si awọn akojọ ti awọn olumulo. Atokọ awọn olumulo, ṣiṣe idajọ nipasẹ iṣeto oludari wa, le ṣee gba lati url localhost: 3000/awọn olumulo. Jẹ ki a beere fun url yii.
Lẹhin ṣiṣe TestMace o le wo wiwo bi eleyi:

Yara CRUD ẹda pẹlu itẹ-ẹiyẹ, @nestjsx/crud ati TestMace

Ni oke apa osi ni igi akanṣe kan pẹlu ipade gbongbo kan Project. Jẹ ki a gbiyanju lati ṣẹda ibeere akọkọ lati gba atokọ ti awọn olumulo. Fun eyi a yoo ṣẹda Ìbéèrè Igbesẹ ipade Eyi ni a ṣe ni akojọ aṣayan ọrọ ti oju ipade Project Ṣafikun ipade ->Ibeere Igbesẹ.

Yara CRUD ẹda pẹlu itẹ-ẹiyẹ, @nestjsx/crud ati TestMace

Ni aaye URL, lẹẹmọ localhost:3000/awọn olumulo ati ṣiṣe ibeere naa. A yoo gba koodu 200 pẹlu orun sofo ninu ara idahun. O jẹ oye, a ko ṣafikun ẹnikẹni sibẹsibẹ.
Jẹ ki a ṣẹda iwe afọwọkọ ti yoo pẹlu awọn igbesẹ wọnyi:

  1. ṣiṣẹda olumulo;
  2. ìbéèrè fun id ti olumulo tuntun ti a ṣẹda;
  3. piparẹ nipasẹ id olumulo ti a ṣẹda ni igbesẹ 1.

Nitorina, jẹ ki a lọ. Fun wewewe, jẹ ki ká ṣẹda a ipade bi folda. Ni pataki, eyi jẹ folda kan ninu eyiti a yoo fipamọ gbogbo iwe afọwọkọ naa. Lati ṣẹda ipade Folda kan, yan Ise agbese lati inu akojọ ọrọ ti ipade naa Fi ipade kun -> Folda. Jẹ ki a pe ipade naa ṣayẹwo-ṣẹda. Inu kan ipade ṣayẹwo-ṣẹda Jẹ ki a ṣẹda ibeere akọkọ wa lati ṣẹda olumulo kan. Jẹ ká pe awọn rinle da ipade ṣẹda-olumulo. Iyẹn ni, ni akoko yii awọn ilana ipade yoo dabi eyi:

Yara CRUD ẹda pẹlu itẹ-ẹiyẹ, @nestjsx/crud ati TestMace

Jẹ ki a lọ si taabu ṣiṣi ṣẹda-olumulo ipade. Jẹ ki a tẹ awọn paramita wọnyi fun ibeere naa:

  • Iru ibeere - POST
  • URL - localhost: 3000 / awọn olumulo
  • Ara - JSON pẹlu iye {"email": "[email protected]", "displayName": "New user", "username": "user"}

Jẹ ki a mu ibeere yii ṣẹ. Ohun elo wa sọ pe a ti ṣẹda igbasilẹ naa.

Yara CRUD ẹda pẹlu itẹ-ẹiyẹ, @nestjsx/crud ati TestMace

O dara, jẹ ki a ṣayẹwo otitọ yii. Lati le ṣiṣẹ pẹlu id ti olumulo ti o ṣẹda ni awọn igbesẹ ti o tẹle, paramita yii gbọdọ wa ni fipamọ. Ilana naa jẹ pipe fun eyi. ìmúdàgba oniyipada. Jẹ ki a lo apẹẹrẹ wa lati wo bi a ṣe le ṣiṣẹ pẹlu wọn. Ninu taabu ti a ti tu silẹ ti idahun, lẹgbẹẹ id node ninu atokọ ọrọ, yan nkan naa Fi si oniyipada. Ninu apoti ibaraẹnisọrọ o gbọdọ ṣeto awọn paramita wọnyi:

  • ipade — ninu ewo ni ti awọn baba lati ṣẹda a ìmúdàgba oniyipada. Jẹ ki a yan ṣayẹwo-ṣẹda
  • Orukọ ayípadà - awọn orukọ ti yi ayípadà. Jẹ ki a pe userId.

Eyi ni ilana ti ṣiṣẹda oniyipada ti o ni agbara dabi:

Yara CRUD ẹda pẹlu itẹ-ẹiyẹ, @nestjsx/crud ati TestMace

Ni bayi, nigbakugba ti ibeere yii ba ti ṣiṣẹ, iye ti oniyipada ti o ni agbara yoo ni imudojuiwọn. Ati nitori ìmúdàgba oniyipada atilẹyin siseto ti ogún logalomomoise, oniyipada userId yoo wa ninu awọn arọmọdọmọ ṣayẹwo-ṣẹda ipade ti eyikeyi tiwon ipele.
Oniyipada yii yoo wulo fun wa ni ibeere atẹle. Eyun, a yoo beere olumulo tuntun ti a ṣẹda. Bi omo kan ipade ṣayẹwo-ṣẹda a yoo ṣẹda ìbéèrè ṣayẹwo-ti o ba wa pẹlu paramita url dogba localhost:3000/users/${$dynamicVar.userId}. Wo apẹrẹ ${variable_name} eyi n gba iye ti oniyipada kan. Nitori A ni oniyipada ti o ni agbara, nitorinaa lati gba o nilo lati wọle si nkan naa $dynamicVar, i.e. wọle patapata a ìmúdàgba oniyipada userId yoo dabi eleyi ${$dynamicVar.userId}. Jẹ ki a ṣiṣẹ ibeere naa ki o rii daju pe a beere data naa ni deede.
Igbesẹ to kẹhin ti o ku ni lati beere piparẹ. A nilo kii ṣe lati ṣayẹwo iṣẹ ṣiṣe ti piparẹ nikan, ṣugbọn tun, bẹ lati sọ, lati sọ di mimọ lẹhin ara wa ni ibi ipamọ data, nitori Imeeli ati awọn aaye orukọ olumulo jẹ alailẹgbẹ. Nitorinaa, ninu ayẹwo-ṣẹda ipade a yoo ṣẹda ibeere olumulo-parẹ pẹlu awọn aye atẹle

  • Iru ibeere - PA
  • URL - localhost:3000/users/${$dynamicVar.userId}

Jẹ ki a ṣe ifilọlẹ. A duro. A gbadun abajade)

O dara, ni bayi a le ṣiṣe gbogbo iwe afọwọkọ yii nigbakugba. Lati ṣiṣẹ iwe afọwọkọ o nilo lati yan lati inu akojọ aṣayan ọrọ ṣayẹwo-ṣẹda ipade ohun kan Run.

Yara CRUD ẹda pẹlu itẹ-ẹiyẹ, @nestjsx/crud ati TestMace

Awọn apa inu iwe afọwọkọ yoo ṣiṣẹ ni ọkọọkan
O le ṣafipamọ iwe afọwọkọ yii si iṣẹ akanṣe rẹ nipa ṣiṣe Faili -> Fi iṣẹ akanṣe pamọ.

ipari

Gbogbo awọn ẹya ti awọn irinṣẹ ti a lo ni irọrun ko le baamu si ọna kika nkan yii. Bi fun ẹlẹṣẹ akọkọ - package itẹ-ẹiyẹjsx/crud - awọn koko-ọrọ wọnyi ko wa ni ṣiṣi:

  • aṣa afọwọsi ati iyipada ti awọn awoṣe;
  • ede ibeere ti o lagbara ati lilo irọrun ni iwaju;
  • atunkọ ati fifi awọn ọna tuntun kun si awọn olutona crud;
  • atilẹyin swagger;
  • caching isakoso.

Bibẹẹkọ, paapaa ohun ti a ṣalaye ninu nkan naa ti to lati ni oye pe paapaa iru ilana ile-iṣẹ bi NestJS ni awọn irinṣẹ fun adaṣe ohun elo iyara. Ati iru IDE itura bi TestMace gba ọ laaye lati ṣetọju iyara ti a fun.

Koodu orisun fun nkan yii, pẹlu iṣẹ akanṣe naa TestMace, wa ninu ibi ipamọ https://github.com/TestMace/nest-rest. Lati ṣii ise agbese kan TestMace kan ṣe ni app Faili -> Ṣii iṣẹ akanṣe.

orisun: www.habr.com

Fi ọrọìwòye kun