Share My Creation Web API Template

Web API Template
Version: 1.15
Description: A boilerplate for creating REST API Server with database CRUD functionalities.

web-api-01.png


web-api-02.png


web-api-03.png


Depends on following libraries: ByteConverter, JavaObject, jServer, Json, jSQL
1661536062812.png


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.

Create B4X template from source:
  1. Download the repo from GitHub
  2. Archive the files inside "Web API" directory as "Web API Server (1.15).zip" using WinRAR or 7-Zip
  3. Rename the extension from .zip to .b4xtemplate

How to use:
  1. Copy the "Web API Server (1.15).b4xtemplate" file into B4J Additional Libraries folder.
  2. Open B4J and create a new project with "Web API" template. Give your project any name you like, for e.g. WebAPI
  3. Run the project in Debug or Release mode. You will see something like this in the Logs:
    B4X:
    Web API Server (version = 1.15) is running on port 19800
    Open the following URL from your web browser
    http://127.0.0.1:19800/v1/
  4. Copy the URL showed in Logs and open it using your web browser.

5. To connect to MySQL server, go to Objects folder and open "config.ini". Comment the SQLite section and uncomment the MySQL section.​
1630137963547.png
6. Edit the root password at line #42 (second last line). Save the file.​
7. In B4J project, comment the line '#AdditionalJar: sqlite-jdbc-3.39.3.0 and uncomment the line #AdditionalJar: mysql-connector-java-5.1.49.​
Make sure you are using the correct version of connector.​
B4X:
#Region AdditionalJar
' MySQL connector
#AdditionalJar: mysql-connector-java-5.1.49
' SQLite connector
'#AdditionalJar: sqlite-jdbc-3.39.3.0
#End Region
8. Follow step #3 above.​

Note: "Web API Client.b4xtemplate" is also attached to demonstrate how to consume the Web API using B4A, B4i and B4J

About auto generated help file (version 1.10+)

https://www.b4x.com/android/forum/threads/web-api-template.133764/post-851114

Client App (B4X):
B4A.png
. .
B4i.png
. .
B4J.png


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

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. 😄

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

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
 

Attachments

  • ajax-test.zip
    30.2 KB · Views: 464
  • Web API Client (1.04).b4xtemplate
    444.3 KB · Views: 126
  • Web API Server (1.15).b4xtemplate
    479 KB · Views: 79
Last edited:

aeric

Expert
Licensed User
Longtime User
I just use a new version when available:
 

aeric

Expert
Licensed User
Longtime User
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

Expert
Licensed User
Longtime User
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

Expert
Licensed User
Longtime User
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.
 
Last edited:

aeric

Expert
Licensed User
Longtime User
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
 
Top