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

aeric · Aug 26, 2021

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:

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

How to use:

Copy the "Web API Server (1.16).b4xtemplate" file into B4J Additional Libraries folder.
Open B4J and create a new project with "Web API Server" template.
Give your project any name you like, for e.g. WebAPI

Run the project in Debug mode.
You will see something like this in the Logs:

B4X:

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/

Copy the URL showed in Logs and open it using your web browser.
To connect to MySQL server, go to Objects folder and open "config.ini".
Comment the SQLite section and uncomment the MySQL section.
Edit the root password at line #45 (second last line). Save the file.
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.
B4X:
```
#Region AdditionalJar
' MySQL connector
#AdditionalJar: mysql-connector-java-8.0.30
' SQLite connector
'#AdditionalJar: sqlite-jdbc-3.39.3.0
#End Region
```
Follow step #3 above.

Client Template:

Web API Client (1.05).b4xtemplate

. . . .

How to use:

Copy the "Web API Client (1.05).b4xtemplate" file into B4X Additional Libraries folder.
Open B4A (B4J or B4i) and create a new project with "Web API Client (1.05)" template.

Edit the URL with your Web API Server host or IP

B4X:

Private URL As String = "http://192.168.50.42:17178/v1/" ' Change to your Web API Server URL

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.

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

Nick McCulloch · Mar 6, 2022

Hi,

Just tried to set this up but I get a bunch of errors in the creation of the sqlite db as follows:

Waiting for debugger to connect...
Program started.
Reading file (E:\Projects\B4J\WAFolder\WebApi\Objects\config.ini)...
Reading file (E:\Projects\B4J\WAFolder\WebApi\Objects\queries-sqlite.ini)...
2022-03-06 15:52:14.422:INFO::main: Logging initialized @625ms to org.eclipse.jetty.util.log.StdErrLog
Checking database...
Database not found!
Creating database...
java.sql.SQLException: [SQLITE_ERROR] SQL error or missing database (near ",": syntax error)
at org.sqlite.DB.newSQLException(DB.java:383)
at org.sqlite.DB.newSQLException(DB.java:387)
at org.sqlite.DB.throwex(DB.java:374)
at org.sqlite.NativeDB.prepare(Native Method)
at org.sqlite.DB.prepare(DB.java:123)
at org.sqlite.PrepStmt.<init>(PrepStmt.java:42)
at org.sqlite.Conn.prepareStatement(Conn.java:404)
at org.sqlite.Conn.prepareStatement(Conn.java:399)
at org.sqlite.Conn.prepareStatement(Conn.java:383)
at anywheresoftware.b4j.objects.SQL$2.run(SQL.java:264)
at java.base/java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:515)
at java.base/java.util.concurrent.FutureTask.run(FutureTask.java:264)
at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1128)
at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:628)
at java.base/java.lang.Thread.run(Thread.java:834)
2022-03-06 15:52:26.385:INFOejs.Server:main: jetty-9.4.z-SNAPSHOT; built: 2018-05-03T15:56:21.710Z; git: daa59876e6f384329b122929e70a80934569428c; jvm 11.0.1+13
2022-03-06 15:52:26.408:INFOejs.session:main: DefaultSessionIdManager workerName=node0
2022-03-06 15:52:26.408:INFOejs.session:main: No SessionScavenger set, using defaults
2022-03-06 15:52:26.409:INFOejs.session:main: node0 Scavenging every 660000ms
2022-03-06 15:52:26.413:INFOejsh.ContextHandler:main: Started o.e.j.s.ServletContextHandler@482bce4f{/,file:///E:/Projects/B4J/WAFolder/WebApi/Objects/www/,AVAILABLE}
2022-03-06 15:52:26.416:INFOejs.AbstractNCSARequestLog:main: Opened E:\Projects\B4J\WAFolder\WebApi\Objects\logs\b4j-2022_03_06.request.log
2022-03-06 15:52:26.561:INFOejs.AbstractConnector:main: Started ServerConnector@32b260fa{HTTP/1.1,[http/1.1]}{0.0.0.0:19800}
2022-03-06 15:52:26.561:INFOejs.Server:main: Started @12767ms
Emulated network latency: 100ms
Web API server (version = 1.11) is running on port 19800
Open the following URL from your web browser

http://127.0.0.1:19800/v1/

Database creation failed!

This is using sqlite-jdbc-3.7.2 , can anyone help?

Nick

aeric · Mar 6, 2022

Nick McCulloch said:
This is using sqlite-jdbc-3.7.2

Try download and use the latest sqlite-jdbc-3.36.0.2 or sqlite-jdbc-3.36.0.3

Nick McCulloch · Mar 6, 2022

Thank you. That worked a treat

aeric · May 28, 2022

Web API - v1.12 (fixed a bug in HelpHandler.bas when reading commented line)
Web API Client - v1.0.3 (Converted to B4XTemplate)

rasaliad · Jun 18, 2022

Hi,

I'm try to compile a project with Web API Template and get this error:

B4J Version: 9.30
Parsing code. (0.02s)
Java Version: 11
Building folders structure. (0.01s)
Compiling code. (0.02s)
Compiling layouts code. (0.00s)
Organizing libraries. (0.00s)
Compiling generated Java code. Error
src\b4j\webapi\corsfilter.java:6: error: package jakarta.servlet does not exist
import jakarta.servlet.DispatcherType;
^
1 error

javac 11.0.1

Thanks in advanced

Rafael

rosippc64a · Jun 18, 2022

Maybe a download? https://search.maven.org/artifact/jakarta.servlet/jakarta.servlet-api/6.0.0/jar

rasaliad · Jun 18, 2022

Thanks rosippc64a

I downloaded the jar from the link you give to me, but the error persist.

I download and put in (I put in the Libraries folder first, but not work):

where i have to copy the .jar file?

Thanks

aeric · Jun 19, 2022

rasaliad said:
Hi,

I'm try to compile a project with Web API Template and get this error:

B4J Version: 9.30
Parsing code. (0.02s)
Java Version: 11
Building folders structure. (0.01s)
Compiling code. (0.02s)
Compiling layouts code. (0.00s)
Organizing libraries. (0.00s)
Compiling generated Java code. Error
src\b4j\webapi\corsfilter.java:6: error: package jakarta.servlet does not exist
import jakarta.servlet.DispatcherType;
^
1 error

javac 11.0.1

Thanks in advanced

Rafael

jServer v4.0 - Based on Jetty 11

Starting from B4J v9.80 this library is included as an internal library. Old library: https://www.b4x.com/android/forum/threads/141323/#content This is a new version of jServer. It is based on Jetty 11.0.9. Previous versions were based on an early version of Jetty 9. There were many improvements...

www.b4x.com

Edit: Sorry, I forgot to mention about I updated to new jServer 4. I update the first post.

rasaliad · Jun 19, 2022

aeric said:
jServer v4.0 - Based on Jetty 11

Starting from B4J v9.80 this library is included as an internal library. Old library: https://www.b4x.com/android/forum/threads/141323/#content This is a new version of jServer. It is based on Jetty 11.0.9. Previous versions were based on an early version of Jetty 9. There were many improvements...

www.b4x.com

Edit: Sorry, I forgot to mention about I updated to new jServer 4. I update the first post.

thanks aeric

Yes I begin to use Web API Template today. I'm using the last version

And I'm using the jServer V4.0

The Web API compile Ok if I comment the jakarta import lines and uncomment the javax importe lines in the CorsFilter file.

the error reported using the jakarta import when compiling is:

B4J Version: 9.30
Parsing code. (0.02s)
Java Version: 11
Building folders structure. (0.01s)
Compiling code. (0.02s)
Compiling layouts code. (0.00s)
Organizing libraries. (0.00s)
Compiling generated Java code. Error
src\b4j\webapi\corsfilter.java:6: error: package jakarta.servlet does not exist
import jakarta.servlet.DispatcherType;
^
1 error

javac 11.0.1

What i'm doing wrong?

Thanks again.

Rafael

aeric · Jun 19, 2022

rasaliad said:
thanks aeric

Yes I begin to use Web API Template today. I'm using the last version

View attachment 130542

And I'm using the jServer V4.0

View attachment 130543

The Web API compile Ok if I comment the jakarta import lines and uncomment the javax importe lines in the CorsFilter file.

View attachment 130544

the error reported using the jakarta import when compiling is:

B4J Version: 9.30
Parsing code. (0.02s)
Java Version: 11
Building folders structure. (0.01s)
Compiling code. (0.02s)
Compiling layouts code. (0.00s)
Organizing libraries. (0.00s)
Compiling generated Java code. Error
src\b4j\webapi\corsfilter.java:6: error: package jakarta.servlet does not exist
import jakarta.servlet.DispatcherType;
^
1 error

javac 11.0.1

What i'm doing wrong?

Thanks again.

Rafael

I need to double check. At the meantime, can you try find previous version “web api.b4xtemplate” from GitHub v1.11 and use jServer v3.0 ?

rasaliad · Jun 19, 2022

aeric said:
I need to double check. At the meantime, can you try find previous version “web api.b4xtemplate” from GitHub v1.11 and use jServer v3.0 ?

thanks aeirc

For now i'm using your web api commenting the import in the CorsFilter file, like this:

import javax.servlet.DispatcherType;
import javax.servlet.Filter;
//import jakarta.servlet.DispatcherType;
//import jakarta.servlet.Filter;

and it is working. Is there any problem doing that?

thanks

aeric · Jun 19, 2022

rasaliad said:
thanks aeirc

For now i'm using your web api commenting the import in the CorsFilter file, like this:

import javax.servlet.DispatcherType;
import javax.servlet.Filter;
//import jakarta.servlet.DispatcherType;
//import jakarta.servlet.Filter;

and it is working. Is there any problem doing that?

thanks

If it is working with this workaround, then you can treat it as a solution. jServer 4.0 is consider a beta so it is optional to upgrade. In case there is an issue, just fall back to the stable version. It is my mistake before go through more testing. You also can exclude the Cors module as it is an additional feature. The Web API can work without this piece.

aeric · Jun 19, 2022

rasaliad said:
Thanks rosippc64a

I downloaded the jar from the link you give to me, but the error persist.

I download and put in (I put in the Libraries folder first, but not work):

View attachment 130532

where i have to copy the .jar file?

Thanks

By the way, I don’t recommend to download the library from different source.
Please download the library provided by Erel in the jServer v4.0 link.

rasaliad · Jun 19, 2022

aeric said:
By the way, I don’t recommend to download the library from different source.
Please download the library provided by Erel in the jServer v4.0 link.

Hi

Yes i download from Erel post. Thansk for the advice.

aeric · Jun 21, 2022

rasaliad said:
thanks aeric

Yes I begin to use Web API Template today. I'm using the last version

View attachment 130542

And I'm using the jServer V4.0

View attachment 130543

The Web API compile Ok if I comment the jakarta import lines and uncomment the javax importe lines in the CorsFilter file.

View attachment 130544

the error reported using the jakarta import when compiling is:

B4J Version: 9.30
Parsing code. (0.02s)
Java Version: 11
Building folders structure. (0.01s)
Compiling code. (0.02s)
Compiling layouts code. (0.00s)
Organizing libraries. (0.00s)
Compiling generated Java code. Error
src\b4j\webapi\corsfilter.java:6: error: package jakarta.servlet does not exist
import jakarta.servlet.DispatcherType;
^
1 error

javac 11.0.1

What i'm doing wrong?

Thanks again.

Rafael

It seems your jServer folder is different from mine.

aeric · Jun 21, 2022

rasaliad said:
thanks aeric

Yes I begin to use Web API Template today. I'm using the last version

View attachment 130542

And I'm using the jServer V4.0

View attachment 130543

The Web API compile Ok if I comment the jakarta import lines and uncomment the javax importe lines in the CorsFilter file.

View attachment 130544

the error reported using the jakarta import when compiling is:

B4J Version: 9.30
Parsing code. (0.02s)
Java Version: 11
Building folders structure. (0.01s)
Compiling code. (0.02s)
Compiling layouts code. (0.00s)
Organizing libraries. (0.00s)
Compiling generated Java code. Error
src\b4j\webapi\corsfilter.java:6: error: package jakarta.servlet does not exist
import jakarta.servlet.DispatcherType;
^
1 error

javac 11.0.1

What i'm doing wrong?

Thanks again.

Rafael

I am unable to reproduce your error. I noticed you are still using B4J version 9.30. Maybe that is the issue. I am using B4J version 9.50 and version 9.80 will be released very soon. You should use more recent version.

I also mentioned that your jServer files also different from mine. Please try to use the new jServer.jar from here or wait for B4J version 9.80.

aeric · Aug 24, 2022

A small update on homepage (coming soon).
Add, Edit and Delete product using Bootstrap modal and jQuery.

aeric · Aug 25, 2022

Updates:
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

peacemaker · Aug 25, 2022

aeric said:
- SQLite version point to sqlite-jdbc-3.39.2.0

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

Mashiane · Aug 26, 2022

Hi

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

Awesome work!

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

Attachments

Member

Expert

Member

Expert

Member

Active Member

Member

Expert

Member

Expert

Member

Expert

Expert

Member

Expert

Expert

Expert

Expert

Expert

Expert

Similar Threads

Privacy & Transparency

Privacy & Transparency