Share My Creation [Project Template] Web API Server

Version: 1.16
Description: Create Web API Server with CRUD functionalities

Updates:
Web API Server 2.0 is available. Check https://www.b4x.com/android/forum/threads/project-template-web-api-server-2.143310/

Template:

• Web API Server (1.16).b4xtemplate

Depends on following libraries:

• ByteConverter
• JavaObject
• jServer
• Json
• jSQL

Features:

1. CRUD based - RESTful Web API (GET, POST, PUT, DELETE)
2. Front-end (HTML, CSS, JS, Bootstrap)
3. Support MySQL and SQLite database (Can be modified for MS SQL or SQL Express)
4. Separate SQL queries file (queries-mysql.ini and queries-sqlite.ini)
5. Sample database auto-generated for first run (Category and Product tables with dummy data)
6. Versioning (using ROOT_PATH in config.ini, set as "/" if you don't want versioning)
7. Auto generated documentation with API test.

How to use:

1. Copy the "Web API Server (1.16).b4xtemplate" file into B4J Additional Libraries folder.
2. Open B4J and create a new project with "Web API Server" template.
3. Give your project any name you like, for e.g. WebAPI
4. Run the project in Debug mode.
   You will see something like this in the Logs:
   
   Web API Server (version = 1.16) is running on port 19800
   Open the following URL from your web browser
   http://127.0.0.1:19800/v1/
5. Copy the URL showed in Logs and open it using your web browser.
6. To connect to MySQL server, go to Objects folder and open "config.ini".
7. Comment the SQLite section and uncomment the MySQL section.
8. Edit the root password at line #45 (second last line). Save the file.
   
   
9. In B4J project, comment the line
   '#AdditionalJar: sqlite-jdbc-3.39.3.0
   and uncomment the line
   #AdditionalJar: mysql-connector-java-8.0.30.
   Make sure you are using the correct version of connector.
   
   #Region AdditionalJar
   ' MySQL connector
   #AdditionalJar: mysql-connector-java-8.0.30
   ' SQLite connector
   '#AdditionalJar: sqlite-jdbc-3.39.3.0
   #End Region
10. Follow step #3 above.

Client Template:

• Web API Client (1.05).b4xtemplate

. .

. .

How to use:

1. Copy the "Web API Client (1.05).b4xtemplate" file into B4X Additional Libraries folder.
2. Open B4A (B4J or B4i) and create a new project with "Web API Client (1.05)" template.
3. Edit the URL with your Web API Server host or IP
   
   Private URL As String = "http://192.168.50.42:17178/v1/" ' Change to your Web API Server URL
4. Run in debug.

Video:

Comments: I try to make this template as compact as possible (remove user table and email function) but it is still big. If you don't like some features, just remove them.

Spoiler: Release Logs

12/04/2023
- Web API Server - v1.16
- Similar to Web API Template 2.0, it is now less confusing by using #Desc and #Path for documentation
- Web API Client - v1.0.5 (compatible with Web API Server v1.16)

03/10/2022
- Web API Server - v1.15
- JS: Fixed bug point to wrong id for Category dropdown in Edit dialog
- JS: Remove comma in thousand for price textbox in Edit dialog
- Add a Home button in Category page

01/10/2022
- Web API Server - v1.14
- Manage Category in new page
- Dynamic populate Category dropdown in add/edit product dialog
- Improve JS scripts
- SQLite version point to sqlite-jdbc-3.39.3.0

27/08/2022
- Web API Client - v1.0.4 (compatible with Web API Server v1.13)

25/08/2022
- Web API Server - v1.13
- Home page with Add, Edit and Delete Product (using Bootstrap modal and jQuery Validate)
- Help or API documentation page improvements
- Many variables and SQL commands are renamed!
- SQLite version point to sqlite-jdbc-3.39.2.0
- Separate Category and Product handlers
- FindHandler added for more search endpoints
- Endpoints structure changed!
- Warning: This version is not compatible with Web API Client v1.0.3 and below

28/05/2022
- Web API - v1.12 (fixed a bug in HelpHandler.bas when reading commented line)
- Updated to use jServer v4.0
- Web API Client - v1.0.3 (Converted to B4XTemplate)

26/01/2022
- Create Publish.zip using #CustomBuildAction
- Create Publish.zip using Comment Link

19/10/2021 - v1.11
- Better use of Connection Pool for MySQL (do not close pool)
- Change DataUtils module to DataConnector class
- Clean up some redundant codes

08/10/2021
- WebAPI Client - v1.02
- - Some bugs fix and UI improvements

24/9/2021 - v1.10
- Auto generated documentation/help file based on handler classes (Click on the Question mark icon on top right corner to access the help file)

06/09/2021
- WebAPI Client - v1.01
- - Some bugs fix and UI improvements

04/09/2021 - v1.09
- Fixed PutProductByCategoryAndId to update Product as different Category.
- WebAPI Client (B4X) - v1.00

02/09/2021 - v1.08
- Added ConfigureCORS for ajax request.

01/09/2021 - v1.07
- Changes in Utility module (ReturnSuccess and ReturnSuccess2) require Status Code.
- Changes in ProductHandler (PostCategory and PostProductByCategory) return new record as result with Status Code 201.

27/08/2021 - v1.06
- Support for SQLite database

About auto generated help file (version 1.10+)
https://www.b4x.com/android/forum/threads/web-api-template.133764/post-851114

 

[aeric]

https://repo1.maven.org/maven2/org/xerial/sqlite-jdbc/3.39.2.0/sqlite-jdbc-3.39.2.0.jar

I just use a new version when available:

SQLite JDBC - Library version updates

Hi everybody! This thread is supposed to get all SQLite JDBC library version links together so as to find and download them easier. As a heavy B4J+SQLite user, I'm always looking forward to have new JDBC versions. All information contained herein has been taken from Mr. Taro L. Saito (xerial)...

www.b4x.com

 

[aeric]

Hi

Is this code backward compatible to jServer 3 or its just now ONLY usable with jServer 4?

Awesome work!

The template should be working with jServer3. The only modification is in CorsFilter.

 

[aeric]

27/08/2022
- Web API Client - v1.0.4 (compatible with Web API Server v1.13)
- Web API version 1.12 and Web API Client v1.03 removed

 

[aeric]

YouTube video updated in post #1

 

[aeric]

Updates:
01/10/2022
- Web API Server - v1.14
- Manage Category in new page
- Dynamic populate Category dropdown in add/edit product dialog
- Improve JS scripts
- SQLite version point to sqlite-jdbc-3.39.3.0

Took me a while to fix the javascript bug form data become empty when validation failed. Now it is working fine.

edit: there is a minor bug. Will fix it soon.

 

[aeric]

Updates:
03/10/2022
- Web API Server - v1.15
- JS: Fixed bug point to wrong id for Category dropdown in Edit dialog
- JS: Remove comma in thousand for price textbox in Edit dialog
- Add a Home button in Category page

 

[aeric]

Live demo: https://api.puterise.com:19900/v1/

Live demo is now terminated.

 

[aeric]

Web API Server - v1.16 beta 1 (Beta.zip attached in post #1)
Similar to Web API Template 2.0, it is now less confusing by using #Desc and #Elements for documentation

Note: This is a breaking update which causes B4X Web API Client not working (due to changes in Handler name to plural)

 

[aeric]

Updates:
12/04/2023
- Web API Server - v1.16
- Similar to Web API Template 2.0, it is now less confusing by using #Desc and #Path for documentation
- Web API Client - v1.0.5 (compatible with Web API Server v1.16)

Example:

Private Sub GetCategory (cid As Int) As HttpResponseMessage
    #region Documentation
    ' #Desc = Get a category by id
    ' #Path = [":cid"]
    #End region
    Try
        Dim List1 As List
        List1.Initialize
       
        Dim con As SQL = Main.DB.GetConnection
        Dim strSQL As String = Main.queries.Get("SELECT_CATEGORY_BY_ID")
        Dim res As ResultSet = con.ExecQuery2(strSQL, Array As String(cid))
        Do While res.NextRow
            Dim Map2 As Map
            Map2.Initialize
            For i = 0 To res.ColumnCount - 1
                Select res.GetColumnName(i)
                    Case "id"
                        Map2.Put(res.GetColumnName(i), res.GetInt2(i))
                    Case Else
                        Map2.Put(res.GetColumnName(i), res.GetString2(i))
                End Select
            Next
            List1.Add(Map2)
        Loop
        res.Close
       
        If List1.Size > 0 Then
            HRM.ResponseCode = 200
        Else
            HRM.ResponseCode = 404
            HRM.ResponseError = "Category Not Found"
        End If
        HRM.ResponseData = List1
    Catch
        LogError(LastException)
        HRM.ResponseCode = 422
        HRM.ResponseError = "Error Execute Query"
    End Try
    Main.DB.CloseDB(con)
    Return HRM
End Sub

 

[aeric]

I also broke my principle as I stated above by repeating the Javascript code. I am sure there is one or more elegant ways to do it.

Finally I found a way, using class selector instead of id. Now I can have a fixed JS file, no need to generate it dynamically.

 

[aeric]

Hi
Is it already finished or does the version of the Web Api server 2.5 with the Dashboard exist?

Please start a new thread.
This is Web API Server template version 1.x but you are seems asking about version 2.x
If you are looking for Web API Server template 2.x then you can go to top of the first post, there is a link to that thread.