Skip to content

Latest commit

 

History

History
168 lines (106 loc) · 7.54 KB

readme.md

File metadata and controls

168 lines (106 loc) · 7.54 KB
Raw

Setup and Run

To run your project, the system requires various runtime systems for data access, api, and logic. These are included with API Logic Server (architecture doc here). So, to run your project (instructions here):

  1. Establish your Python Environment to activate these runtime systems
  2. Run

 

Key Customization Files

Your project is ready to run, but it's likely you'll want to customize it - declare logic, new endpoints, etc.

The Key Customization Files listed in the table below are created as stubs, intended for you to add customizations that extend the created API, Logic and Web App.

  • Since they are separate files, the project can be rebuilt (e.g., synchronized with a revised schema), preserving your customizations.

Please see the nw sample for examples of typical customizations. You can open it in GitHub (use Shift + "." to view in project mode) - click here.

Directory Usage Key Customization File Typical Customization
api JSON:API
Ready to Run		 api/customize_api.py Add new end points / services
ui Multi-Page Admin App
Ready to Run		 ui/admin/admin.yaml Control field display - order, captions etc.
database SQLAlchemy Data Model Classes database/customize_models.py Add derived attributes, and relationships missing in the schema
logic Transactional Logic
spreadsheet-like rules		 logic/declare_logic.py Declare multi-table derivations, constraints, and Python events such as send mail / messages
security Authentication, Authorization security/declare_security.py Control login, role-based row access
tests Behave Test Suite tests/api_logic_server_behave/features Declare and implement Behave Tests

 

Project Requirements

Optionally, you can document requirements as part of an executable test plan. Test plan execution creates documentation (in markdown), including requirements traceability into implementation. See example here.

 

Project Information

This API Logic Project was created with the ApiLogicServer create command. For information on Managing API Logic Projects, click here.

About Info
Created August 01, 2023 18:02:20
API Logic Server Version 09.01.27
Created in directory Northwind1ApiLogic
API Name api
Execution begins with api_logic_server_run.py

 

Setup Instructions

Setup your Python environment, according to whether you did a local install, or Docker. Choose the appropriate section, then run.

 

Establish Your Python Environment - Local Install

You requirements.txt has already been created, so...

python -m venv venv                        # may require python3 -m venv venv
venv\Scripts\activate                      # mac/linux: source venv/bin/activate
python -m pip install -r requirements.txt  # accept "new Virtual environment"

Notes:

  • See also the venv_setup directory in this API Logic Project.

  • If using SqlServer, install pyodbc. Not required for docker-based projects. For local installs, see the Quick Start.

 

Establish Your Python Environment - Docker

Your runtime systems are part of Dev Container, which you probably activated when you opened the project.

  • If you did not accept the "Open in Container" option when you started VSCode, use View > Command Palette > Remote-Containers: Reopen in Container.

 

Run

To run your project

Start Project

As shown above:

  1. Use the pre-supplied Run Configuration; use either:
    • `ApiLogicServer - No Security (e.g., for behave tests to run with security (recommended initially)
    • `ApiLogicServer to run with security
  2. Click the url in the console to start the Admin App
    • Use it to explore your data (shown below)
    • And your API (via Swagger)

Admin App

 

Appendix: Key Technologies

API Logic Server is based on the projects shown below. Consult their documentation for important information.

 

SARFS JSON:API Server

SAFRS: Python OpenAPI & JSON:API Framework

SAFRS is an acronym for SqlAlchemy Flask-Restful Swagger. The purpose of this framework is to help python developers create a self-documenting JSON API for sqlalchemy database objects and relationships.

These objects are serialized to JSON and created, retrieved, updated and deleted through the JSON API. Optionally, custom resource object methods can be exposed and invoked using JSON.

Class and method descriptions and examples can be provided in yaml syntax in the code comments.

The description is parsed and shown in the swagger web interface. The result is an easy-to-use swagger/OpenAPI and JSON:API compliant API implementation.

 

LogicBank

Transaction Logic for SQLAlchemy Object Models

Use Logic Bank to govern SQLAlchemy update transaction logic - multi-table derivations, constraints, and actions such as sending mail or messages. Logic consists of both:

  • Rules - 40X more concise using a spreadsheet-like paradigm, and

  • Python - control and extensibility, using standard tools and techniques

Logic Bank is based on SQLAlchemy - it handles before_flush events to enforce your logic. Your logic therefore applies to any SQLAlchemy-based access - JSON:Api, Admin App, etc.

 

SQLAlchemy

Object Relational Mapping for Python.

SQLAlchemy provides Python-friendly database access for Python.

It is used by JSON:Api, Logic Bank, and the Admin App.

SQLAlchemy processing is based on Python model classes, created automatically by API Logic Server from your database, and saved in the database directory.

 

Admin App

This generated project also contains a React Admin app:

  • Multi-page - including page transitions to "drill down"
  • Multi-table - master / details (with tab sheets)
  • Intelligent layout - favorite fields first, predictive joins, etc
  • Logic Aware - updates are monitored by business logic