Share My Creation [Project Template] [Web] MinimaList API Server

Version: 2.07
Description: Build REST API Server with MinimaList using B4X project template

Sample project: shao (micro-blogging web app)

If you want to connect to an SQL database, see Web API Server 2

---

Template:

• MinimaList API Server (2.07).b4xtemplate

Depends on:

• WebApiUtils.b4xlib
• MinimaListUtils.b4xlib (B4X library)

Optional:

• MinimaListController.jar and MinimaListController.xml

GitHub:

• https://github.com/pyhoon/minimalist-api-b4j
• https://github.com/pyhoon/WebApiUtils-B4J
• https://github.com/pyhoon/MinimaListUtils-B4X
• https://github.com/pyhoon/MinimaListController-B4J

Features:

• Similar to Web API Server 2 but use MinimaListUtils instead of MiniORMUtils library.
• MinimaList is a library for storing key-value or Map into List.
• Meaning this API server does not connect to any SQL database.
• Optionally, MinimaList can be persisted using KeyValueStore library.
• Clients
  • Build-in front-end client (web)
  • Compatible with Web API Client (1.05).b4xtemplate (B4X UI apps) * sc.SimpleResponse.Enable = False

Code example:

Private Sub GetCategory (id As Long)
    ' #Version = v2
    ' #Desc = Read one Category by id
    ' #Elements = [":id"]
 
    Dim M1 As Map = Main.CategoryList.Find(id)
    If M1.Size > 0 Then
        HRM.ResponseCode = 200
    Else
        HRM.ResponseCode = 404
    End If
    HRM.ResponseObject = M1
    ReturnApiResponse
End Sub

Tutorials:

1. Download File Example
2. Vue 3 CRUD Example
3. Using MinimaList Controller
4. Using MinimaList Controller and Code Snippets

Live:

Creating Web API Server with B4X Template​

Spoiler: Part 1: Get Started and configure the server

Spoiler: Part 2: Create a controller from scratch

To seed dummy data in MinimaList API Server, browse to:
http://127.0.0.1:19800/web/?seed=1

This project has been tested many many times. Please report bugs if you found any
Post your question in a new thread.

 

[aeric]

MinimaList API Server
version: 2.06 beta 1

What's New

• (clean) Main module
• (new) ServerConfiguration class
• (update) Controller should be name in plural e.g. ProductsController. http://127.0.0.1:19800/web/api/v2/products
• (update) Controller use #name tag to overwrite the element in Api url e.g. http://127.0.0.1:19800/web/api/v2/product/1
• (remove) HelpHandler #plural tag is now succeeded by #name tag

 

[aeric]

MinimaList API Server
version: 2.06

What's New

• (clean) Main module
• (new) ServerConfiguration class
• (update) Controller should be name in plural e.g. ProductsController. http://127.0.0.1:19800/web/api/v2/products
• (update) Controller use #name tag to overwrite the element in API url e.g. http://127.0.0.1:19800/web/api/v2/product/1
• (remove) HelpHandler #plural tag is now succeeded by #name tag

 

[aeric]

MinimaList API Server
version: 2.07

What's New

• (new) WebApiUtils v2.07
• (new) MinimaListUtils v1.03
• (new) MinimaListController v1.07
• (new) Main module
  • SHOW_API_ICON to control API icon visible on frontend top navbar
• (new) ServerConfiguration class
  • setEnableHelp to disable API Documentation and icon in frontend top navbar
  • setSimpleResponse replaces 3 old variables
• (change) ServerConfiguration class
  • rename some variables
  • change some Public subs to Private
• (change) Some index.html files deleted