Share My Creation [Project Template] Web API Server 2

aeric · Oct 4, 2022

Version: 2.08
Description: Create Web API Server using B4X project template

Database: MySQL, SQLite

Sample project: Support Ticketing System

If you don't want to connect to any SQL database, see MinimaList API Server
For older version, see Web API Server (v1.16)

Template:

Web API Server (2.08).b4xtemplate

Depends on:

GitHub:

Features:

ApiHandler and WebHandler are used for routing to Controller classes
HelpHandler (optional)
- API documentation is generated automatically. You don't need external tools (e.g Postman or Swagger) for testing.
- Access tokens can be embeded into request header in HelpHandler.
- Controller classes are added to a list in Main module to show in the documentation.
Configuration
- Web and API paths
- Versioning
- Simple JSON Response (Map or List)
- Session
- Cookies
- Welcome message
Endpoint
- Endpoint name is based on controller's name by default e.g ProductsController produces /web/api/v2/products
- Endpoint name can be overridden by using #Name tag e.g /web/api/v2/product
- Custom version name using #Version tag e.g v2, live, demo, dev, staging
- Description in documentation is set using #Desc tag (in Web API v1, it was set by #Desc1, #Desc2 or Literals that was very confusing)
- API endpoint can be hidden using #Hide tag
Clients
- Build-in front-end client (web)
- Compatible with Web API Client (1.05).b4xtemplate (B4X UI apps)

Tutorials:

Live:

Creating Web API Server with B4X Template [All Parts]

Learn:

Version History:

(new) WebApiUtils v2.08
(new) MiniORMUtils v1.13
(new) WebAPIController v1.07
(change) Use DbFile instead of DbName for SQLite in config.ini
(change) Move code from ConfigureDatabase sub to Initialize sub in DatabaseConfiguration class
(remove) Delete build configurations and code for Firebird, PostgreSQL and MS SQL

(new) WebApiUtils v2.07
(new) MiniORMUtils v1.11
(new) WebAPIController v1.06
(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

(new) WebApiUtils v2.06
(new) MiniORMUtils v1.10
(new) WebAPIController v1.05
(new) Main module is cleaner
(new) Added ServerConfiguration class
(new) Added DatabaseConfiguration class
(new) Added empty index.html files into assets folders
(new) FindController - case insensitive and wildcard search
(change) Table tbl_category renamed to tbl_categories
(change) ServerConfiguration Update sub renamed to Finalize
(change) better handling of default values in config.ini
(fix) bug in v2.06 beta 1, no database set by default in config.ini
(fix) bug in v2.06 beta 2, PostProduct line#233 in ProductsController causing all data inserted as Timestamp

(new) MinimaList API Server (version 2.05) as a separate template
(new) MiniORMUtils (version 1.07)
(new) MinimaListUtils (version 1.02)
(new) WebApiController (version 1.04)
(new) Use a single public variable SimpleResponse instead of 3 different public variables.
(update) HelpHandler - JavaScript files for search is no longer generated during compilation.
The files are now keep inside assets/js folder instead. SimpleResponse and standard JSON are supported.
Thanks to projects Ticketing Support System and Shao.
(update) Some JavaScript files have been renamed using period instead of dash.

(new) Web Front-end with CRUD demo (similar to version 1)
(new) B4X Web API Client (version 1.05) supported (note: set ConfigureResponse(False))
(new) WebApiUtils.b4xlib (version 2.04) (Utility and WebUtils modules merged)
(new) WebAPIController (version 1.03) is backed
(new) MinimaListUtils.b4xlib (version 1.00)
(new) Database support (tested with SQLite and MySQL)
(new) Build Standalone Package supported
(new) Additional library for jdbc connector is set by selecting a Build configuration during Debug
(new) ConfigureServer subs are now enabled by passing Boolean value instead of commenting the line
(new) Utilize B4J v10.00 Code Snippets feature
(new) DatabaseConnector (for SQLite, MySQL, SQL Server, Firebird, PostgreSQL, DBF)
(new) SeedData for MinimaList
(new) ConfigureResponse added SimpleResponseDataKey (when SimpleResponseFormat = "Map", default is data)
(new) JavaScript files for supporting SimpleResponseFormat
(new) ReturnApiResponse sub added
(fixed) ConfigureServer subs order changed
(fixed) ConfigurePort
(fixed) ConfigurePaths
(fixed) ConfigureElements list element indices during Debug
(fixed) ConfigureHandlers
(fixed) ConfigureResponse added SimpleResponseFormat = "Auto"
(removed) Timezone setting
(removed) DataController class
(removed) ReturnSimpleHttpResponse
(removed) MinimaListController (version 1.05) -> succeeded by WebAPIController
(updated) MinimaList subs are renamed
(updated) ReturnHttpResponse
(updated) All Controllers
(updated) All Handlers
(other) Clean up unused code and many other bugs fixes

Code example:

B4X:

Private Sub GetCategory (id As Long)
    ' #Version = v2
    ' #Desc = Read one Category by id
    ' #Elements = [":id"]

    DB.Table = "tbl_category"
    DB.Find(id)
    If DB.Found Then
        HRM.ResponseCode = 200
        HRM.ResponseObject = DB.First
    Else
        HRM.ResponseCode = 404
        HRM.ResponseError = "Category not found"
    End If
    DB.Close
    ReturnApiResponse
End Sub

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

Special thanks to donors of this project:

aeric · May 11, 2023

Web API Template 2 (MinimaList Edition) - NO Database Needed
version: 2.00
Uploaded in post #1 (only 261KB)

This is a very minimum template where you don't even need to connect to a database to work. Optionally you can start with keyValueStore to persist the model. This will be a foundation to more complex Web API projects.

aeric · May 12, 2023

Optional modules developed during beta version are attached in post #2.

aeric · May 12, 2023

Web API Template 2
version: 2.01
Uploaded in post #1 (only 260KB)

What's New?

Added: IndexController - routes to default home page (index.html template is also added)
Added: WebHandler - call IndexController
Added: CorsFilter
Improved: ApiHandler is now easier to use - A new RouteData sub can be use to route to other methods (e.g RouteDataGet and RouteDataPost)
Note: MinimaList data is now not persist using KeyValueStore by default. Meaning, data is reset when server is restarted. You can uncomment ConfigureKeyValueStore in ConfigureServer sub to persist the data.

byz · May 14, 2023

虽然还没有用你的webapi，但是一直有关注进度的。从帖子里给出的代码看，好像需要配置很多，不知道是否能够简单易用。

aeric · May 14, 2023

byz said:
虽然还没有用你的webapi，但是一直有关注进度的。从帖子里给出的代码看，好像需要配置很多，不知道是否能够简单易用。

Please start a new thread in Chinese forum.
I will provide more examples and tutorials in the future.

请在中文论坛开一个新帖。
以后我会提供更多的例子和教程。

aeric · May 14, 2023

A tutorial is added.

[Web] Web API Tutorial - Getting Started

Note: This tutorial is based on Web API Server v2.02 and is deprecated. Refer to Using MinimaList Controller and Code Snippets Note: Please do not post your question in this thread. Start a new question and tag with [Web API 2] in the title.

www.b4x.com

aeric · May 17, 2023

Web API Template 2
version: 2.02
Uploaded in post #1 (432KB)

What's New?

Improved: ConfigureHandlers in Main module
Improved: More comments and integration guide in Main module
Improved: Removed unused global variables in Main module
Improved: Group unused Configurations in Main module
Improved: ApiHandler minor fixes
Improved: DataController minor fixes
Added: ReadConfig sub in Main module
Added: Shortcut link in AppStart by hovering mouse pointer to open the default page
Added: 2 fontawesome woff files to fix warnings in web dev tools (increases file size)

aeric · May 17, 2023

There is a bug in v2.02
~~Will update it soon~~ Updated v2.02.1 in post #1

Note: DataController is now reading the item id instead of the list item index. This is easier to work with the vue app in Tutorial Example 2.

I need to add

B4X:

Minima.Initialize

before

B4X:

ConfigureServer

or else the object is not initialized.

B4X:

Sub AppStart (Args() As String)
    srvr.Initialize("")       ' Create the server
    ReadConfig                ' Read environment settings
    Minima.Initialize         ' Initialize MinimaList
    ConfigureServer           ' Configure the server
    srvr.Start                ' Start the server
    StartMessageLoop
End Sub

aeric · May 18, 2023

MinimaList Controller (use with MinimaList and KeyValueStore)
version: 1.00
Attached in post #2 (2KB)

Deprecated: Check the new tutorial [Web API 2] Tutorial - Using MinimaList Controller

How to use:

Unzip the jar and xml file to B4J Additional Library folder
Find and check "MinimaListController" in B4J Libraries Manager
Go to menu Project > Add New Module > Class Module and select "MinimaList Controller"
Give a name e.g "UserController"
A boilerplate controller is added with subs contains the word "Item"
You can use Quick Search to rename the word "Item" to "User"

Working with MinimaList

You need to create a new MinimaList object in Main module
In Process_Globals sub of Main module, add the following line:
B4X:
```
Public MinimaUser As MinimaList
```
Inside AppStart sub, initialize the object
B4X:
```
MinimaUser.Initialize
```

In ConfigureControllers sub, add the controller so you can check with the API documentation

B4X:

Public Sub ConfigureControllers
    Controllers.Initialize
    Controllers.Add("DataController")
    Controllers.Add("UserController")
End Sub

Inside UserController class, using Quick Search tab, replace the word "Item" to "User", "Minima" to "MinimaUser"

Go to ApiHandler, inside ProcessRequest sub, add a new route

B4X:

Select ControllerElement
    Case "data"
        RouteData(ApiVersionElement, ControllerIndex, FirstIndex, SecondIndex)
        Return
    Case "user"
        RouteUser(ApiVersionElement, ControllerIndex, FirstIndex)
        Return
End Select

You can clone the code for RouteData (and other related subs) to RouteUser
You can use Quick search, highlight the copied code and replace the word "Data" to "User" using the "In Selection" button
Adjust the parameter or delete SecondIndex if it is not used.
Test the new API using the documentation page.

This is some work. Hopefully the steps are more simplified in the future.

aeric · Jun 9, 2023

Web API Template 2
version: 2.03
Uploaded in post #1 (434KB)

What's New?

Improved: ApiHandler is now more cleaner. All logic should put in controller class. ApiHandler will call the Route method without any parameter of the controller.
Changed: Sub ConfigureResponse is now disabled. JSON Response is now follow "standard" format by default, instead of "simple" format. You can still enable it.

B4X:

Select ControllerElement
    Case "data"
        Dim Data As DataController
        Data.Initialize(Request, Response)
        Data.Route
        Return
    Case "item"
        Dim Item As ItemController
        Item.Initialize(Request, Response)
        Item.Route
        Return
End Select

aeric · Jun 9, 2023

Web API Controller (use with MinimaList and KeyValueStore)
version: 1.01
Attached in post #2 (2KB)

What's New?

Improved: Simplified code flow and no more passing Indices as parameters to methods

Xfood · Jun 10, 2023

aeric said:
Beta 4 development (dashboard)

View attachment 141954
View attachment 141955
View attachment 141956
View attachment 141957
View attachment 141958
View attachment 141959

Hi buddy,
congratulations for your job,
where can we download this fantastic example to try on the pc?

aeric · Jun 10, 2023

Xfood said:
Hi buddy,
congratulations for your job,
where can we download this fantastic example to try on the pc?

I already answered in post #13.
I don't share the blog system as Web API Template 2.0 but will consider to publish as another product.

Xfood · Jun 10, 2023

aeric said:
I already answered in post #13.
I don't share the blog system as Web API Template 2.0 but will consider to publish as another product.

always with the same logic you could create a support ticket system, to manage helpdesk calls, I would be willing to buy such a source, and I also believe many in this community would benefit from it

aeric · Jun 10, 2023

Xfood said:
always with the same logic you could create a support ticket system, to manage helpdesk calls, I would be willing to buy such a source, and I also believe many in this community would benefit from it

Support Ticket System powered by Web API 2

What is your offer price and features you are looking for? Poll will be closed on Jun 23, 2023. Guys, thanks for voting.

www.b4x.com

aeric · Jul 31, 2023

A new version of MinimaList is posted in code snippets

MinimaList - Minimal List of Maps

Update Please refer to the B4X library https://www.b4x.com/android/forum/threads/b4x-web-minimalistutils.155724/ MinimaList Description: Minimal List of Maps Version : 1.02 Treat it as some kind of a NoSQL for key-value pair or KVS. It is suitable for small demo but I don't recommend it...

www.b4x.com

yaqoob · Aug 7, 2023

Great work, and thank you for sharing

aeric · Sep 19, 2023

Web API Template 2
version: 2.04 beta1
(443KB)
Note: This is still in beta version

What's New?

Support B4X Web API Client
Web Front-end with CRUD Demo
MinimaListController replaced WebAPIController

For Web API Client (1.05), modify the following line in B4XMainPage class:

B4X:

'Private URL As String = "http://192.168.50.42:19800/v1/"
Private URL As String = "http://192.168.50.42:19800/web/api/v2/"

aeric · Sep 19, 2023

Web API Template 2
version: 2.04 beta2
(442KB)
Note: This is still in beta version

What's New?

Support B4X Web API Client 1.05
Web Front-end with CRUD Demo
MinimaListController replaced WebAPIController
Changes in ConfigureServer subs order and ConfigurePort is enabled as default
Clean up unused code
Timezone removed
DataController has been removed
Methods inside MinimaList class are renamed

Seed dummy data by calling:

http://127.0.0.1:19800/web/?seed=1

aeric · Sep 21, 2023

Web API Template 2
version: 2.04 beta3
(435KB)
Note: This is still in beta version and for testing B4J 10.00 Snippets feature

What's New?

Support B4X Web API Client 1.05
Web Front-end with CRUD Demo
Changes in ConfigureServer subs order and ConfigurePort is enabled as default
Clean up unused code
Timezone removed
DataController has been removed
Methods inside MinimaList class are renamed
(new) WebApiUtils.b4xlib (with Code Snippets) replaces Utility and WebUtils modules
(new) MinimaListController (version 1.05) replaces WebAPIController

Edit: Check version 2.04 beta 4

Share My Creation [Project Template] Web API Server 2

Attachments

Expert

Expert

Expert

Active Member

Expert

Expert

Expert

Expert

Expert

Expert

Expert

Expert

Expert

Expert

Expert

Expert

Active Member

Expert

Expert

Expert

Similar Threads

Privacy & Transparency

Privacy & Transparency