vouchers-sdk v0.1.0

Software Development Kit

This is a SDK library generated by @nestia/migrate or @nestia/editor.

With this SDK library, you can easily and safely interact with backend server.

Just import and call some API functions like gif image below:

Left is server code, and right is client code utilizing the SDK

How to Test

npm install
npm start # run only "test/start.ts" file
npm run test # everything under the "test/features" directory
npm run test:simulate # "test/features" with mockup simulation mode

If you run npm start command, only test/start.ts file would be executed.

Otherwise you run npm run test command instead, run everything in the test/features directory.

For reference, the test/features directory and E2E test functions (for each API endpoints) would be automatically composed only when you've configured the "E2E test function generation mode" of the @nestia/migrate (or @nestia/editor).

npm install -g @nestia/migrate
npx @nestia/migrate
? Migration mode (Use arrow keys):
    NestJS
  > SDK
? Swagger file location: assets/input/clickhouse.json
? Output directory path: assets/output/clickhouse-sdk-manual
? Mokup Simulator: true
? E2E Test Functions: true

Deploy

npm install
npm run deploy

Just run npm run deploy command, then your SDK library would be published.

By the way, the initial package name of this template repository is @voucher-sdk-api. I think it would better to change the word to your own organization and project name. If you're utilizing VsCode, you can do it through Edit > Replace in Files (Ctrl + Shift + H) feature.

What Nestia is:

Nestia is a set of helper libraries for NestJS, supporting below features:

• @nestia/core: Super-fast decorators
• @nestia/sdk:
  • Swagger generator evolved than ever
  • SDK library generator for clients
  • Mockup Simulator for client applications
  • Automatic E2E test functions generator
• @nestia/migrate: Migration from Swagger to NestJS
• @nestia/editor: Online TypeScript Swagger Editor
• nestia: Just CLI (command line interface) tool

Note

• Only one line required, with pure TypeScript type
• Enhance performance 30x up
  • Runtime validator is 20,000x faster than class-validator
  • JSON serialization is 200x faster than class-transformer
• Software Development Kit
  • SDK is a collection of fetch functions with type definitions like tRPC(https://> trpc.io/)
  • Mockup simulator means embedded backend simulator in SDK
    • similar with msw, but fully automated