Skip to content

Server Folder Structure

Jump to bottom
damiancosmoschapman edited this page Oct 5, 2021 · 2 revisions

Home / Developer / Folder Structure

PDF-API Application Server Side folders

The Root folder contains all files and folders that are needed to create service access point.

root/

  • /Entities
  • /Logs
  • /Resources
  • /Entities
  • /scripts

/Entities

This contains the Entities for the PDF-API application. each Entity is a self-contained module that can be moved anywhere in the Application.

Generally speaking, a functional area folder in Entities is structured as follows:

  • A /BSO folder. This contains the BSO (Business Object) files, with one file for each corresponding API function. So, for example, and API that enables Create, Read, Update and Delete will have a single BSO file for each of these functions.
  • A DTO (Data Transfer Object) file. This file should be used to define DTOs.
  • A VLD (Validation) file. This file should be used to contain the specific validations for the API
  • An API file. This file is used to expose the API methods to the JSON-RPC calls.

\Logs

This folder is included as a placeholder for Log4Net logging files. The folder should be part of the project, however it is not necessary to insert any files here during development. After deployment, any Log4Net files will be deposited in this folder.

\Resources

This contains helper files for the application. These may be held in sub-folders as required

\Scripts

This contains a number of scripts are required for certain processes, notably Log4Net. This folder is used to contain them.

Top

Clone this wiki locally