@barcoding/sdk

The SDK package is an auto-generated API client created from the API's OpenAPI specification.

Overview

• Package: @barcoding/sdk
• Location: web/projects/packages/@barcoding/sdk/
• Generated From: API OpenAPI spec (http://localhost:3000/openapi.json)
• Generator: ng-openapi-gen
• Services: 604+ API controller services

NEVER EDIT MANUALLY

SDK files are auto-generated. Changes will be overwritten on regeneration.

Regenerating the SDK

After API changes:

cd web
yarn build-sdk

This runs:

ng-openapi-gen --input http://localhost:3000/openapi.json --output projects/packages/@barcoding/sdk/src/lib

Usage Example

import { TicketControllerService } from '@barcoding/sdk';

@Component({
  selector: 'app-ticket-list',
  template: '...'
})
export class TicketListComponent implements OnInit {
  tickets: Ticket[] = [];

  constructor(private ticketService: TicketControllerService) {}

  ngOnInit() {
    this.ticketService.ticketControllerFind().subscribe(
      tickets => {
        this.tickets = tickets;
      },
      error => {
        console.error('Failed to load tickets', error);
      }
    );
  }

  createTicket(ticket: Ticket) {
    this.ticketService.ticketControllerCreate({ body: ticket }).subscribe(
      newTicket => {
        this.tickets.push(newTicket);
      }
    );
  }
}

Service Naming Convention

Generated services follow this pattern:

• Controller Name + "Service"
• Examples:
  • TicketControllerService → /tickets endpoints
  • UserControllerService → /users endpoints
  • ConfigControllerService → /config endpoints

Available Methods

Each service has methods corresponding to API endpoints:

• find() → GET /resource
• findById() → GET /resource/
• create() → POST /resource
• updateById() → PATCH /resource/
• deleteById() → DELETE /resource/

Response Types

Methods return Observables:

// Simple Observable
ticketService.ticketControllerFind(): Observable<Ticket[]>

// Observable with HTTP response
ticketService.ticketControllerFind$Response(): Observable<StrictHttpResponse<Ticket[]>>

Coming Soon

This page is under construction. More details will be added about:

• Complete service list
• Error handling
• Request configuration
• Response interceptors
• Best practices

For now, refer to:

• API Overview
• Package Dependencies
• Getting Started