Share My Creation [Project Template] Web API Server

ilan · Aug 26, 2021

looks really nice (and complicated ?)

i do get an error that a lib is missing:

i have some questions to the code but i will start with only 1,

i see that you are using some kind of template variables in your html files. i cannot find where you are updating them except of 'BuildView' function.

what function is responsible for updating the template vars with real data?

thank you

ilan · Aug 26, 2021

ok found it, its inside the config.ini file

those 2 functions:

B4X:

Public Sub BuildHtml (strHTML As String, Settings As Map) As String
    ' Replace $KEY$ tag with new content from Map
    strHTML = WebUtils.ReplaceMap(strHTML, Settings)
    Return strHTML
End Sub

Public Sub BuildView (strHTML As String, View As String) As String
    ' Replace @VIEW@ tag with new content
    strHTML = strHTML.Replace("@VIEW@", View)
    Return strHTML
End Sub

calls the function webutils:

B4X:

Public Sub ReplaceMap(Base As String, Replacements As Map) As String
    Dim pattern As StringBuilder
    pattern.Initialize
    For Each k As String In Replacements.Keys
        If pattern.Length > 0 Then pattern.Append("|")
        pattern.Append("\$").Append(k).Append("\$")
    Next
    Dim m As Matcher = Regex.Matcher(pattern.ToString, Base)
    Dim result As StringBuilder
    result.Initialize
    Dim lastIndex As Int
    Do While m.Find
        result.Append(Base.SubString2(lastIndex, m.GetStart(0)))
        Dim replace As String = Replacements.Get(m.Match.SubString2(1, m.Match.Length - 1))
        If m.Match.ToLowerCase.StartsWith("$h_") Then replace = EscapeHtml(replace)
        result.Append(replace)
        lastIndex = m.GetEnd(0)
    Loop
    If lastIndex < Base.Length Then result.Append(Base.SubString(lastIndex))
    Return result.ToString
End Sub

aeric · Aug 26, 2021

ilan said:
i do get an error that a lib is missing:

Convert collections to json and vice versa

The JSON libraries, which are internal libraries, were updated. The new version is 1.20. There is a new JSON type which is used to convert maps or lists to json strings and vice versa, using the new As keyword. The idea is that you have a collection or string, you direct the compiler to treat...

www.b4x.com

ilan said:
those 2 functions:

Yes. The BuildHtml and BuildView functions are responsible to render the HTML page. BuildView is used to merge the index.html with the main.html if you have other page other than index.html where main.html is the parent page.
Note that WebUtils file is provided by Erel.

As you can see, I am using config.ini and queries.ini and the app loads these 2 files when started.
I have separated these files so it is easy to customize your own values without touching the code.

aeric · Aug 26, 2021

I only use 1 handler for product and category. You may separate it into 2 handlers and have different URLs starting with product and category.
For e.g.

http://127.0.0.1:19800/v1/category/1

http://127.0.0.1:19800/v1/product/2

aeric · Aug 26, 2021

I found a bug. Will upload an update. I only done renumeration for GET inside ProcessRequest but forgot for other methods. ?

aeric · Aug 26, 2021

ProductHandler.bas is updated in the template. Please download the file again. Sorry for any inconvenience.

ilan · Aug 26, 2021

i cannot test it because i need to run a server with MySQL for that. i will update the code to allow SQLite DB for testing.
i do it a lot in my project where i have conditional symbols for SQLite and MySQL to be able to test it anywhere.

aeric · Aug 26, 2021

ilan said:
i cannot test it because i need to run a server with MySQL for that. i will update the code to allow SQLite DB for testing.
i do it a lot in my project where i have conditional symbols for SQLite and MySQL to be able to test it anywhere.

I believe it is easy to achieve.

Edit: I can't imagine using SQLite for the Web API server backend. I know it is possible but I like MySQL and Adminer in Laragon.

ilan · Aug 26, 2021

aeric said:
I believe it is easy to achieve.

yes, should be.
it would be a great addition to b4j to have a place where people could upload their templates so others can download them. if not inside b4x ide it could be an external app or website.

aeric · Aug 26, 2021

ilan said:
it would be a great addition to b4j to have a place where people could upload their templates so others can download them. if not inside b4x ide it could be an external app or website.

Yes it is good but you can always search in B4X forum and download the template.

Alternative download link: https://github.com/pyhoon/webapi-b4j/raw/main/Web API.b4xtemplate

aeric · Aug 26, 2021

v1.06 - Support for SQLite database

Xandoca · Aug 27, 2021

Amazing @aeric !!!
It's really useful project!!!
???

swamisantosh · Aug 27, 2021

aeric said:
I only use 1 handler for product and category. You may separate it into 2 handlers and have different URLs starting with product and category.
For e.g.

http://127.0.0.1:19800/v1/category/1

http://127.0.0.1:19800/v1/category/1

{
"r": [],
"s": "error",
"e": "Error Execute Query",
"m": null
}

aeric · Aug 27, 2021

swamisantosh said:
http://127.0.0.1:19800/v1/category/1
{
"r": [],
"s": "error",
"e": "Error Execute Query",
"m": null
}

May I know you are connecting to MySQL or SQLite db?
What is the error in the Logs?

aeric · Aug 27, 2021

swamisantosh said:
http://127.0.0.1:19800/v1/category/1
{
"r": [],
"s": "error",
"e": "Error Execute Query",
"m": null
}

Are you "POST"ing a new Category?
Sorry, the payload format was incorrect. Please remove the comma sign after the "category_name". I will fix it later. Thanks for letting me know.

JSON:

{
  "name": "category_name"
}

aeric · Aug 28, 2021

There is an issue in MySQL (queries-mysql.ini) in version 1.06
The search queries should be same as SQLite script. The MySQL script was for version 1.05 and it is now fixed.
The issue is at FORMAT(P.product_price, 2) where the currency format is now handled by B4X.

B4X:

Else If res.GetColumnName(i) = "ee" Then
    Map2.Put(res.GetColumnName(i), NumberFormat2(res.GetDouble2(i), 1, 2, 2, True))

# SEARCH
SEARCH_PRODUCT_BY_CATEGORY_CODE_AND_NAME_ONEWORD_ORDERED=SELECT P.id AS aa, \
P.product_code AS bb, C.`category_name` AS cc, P.product_name AS dd, FORMAT(P.product_price, 2) AS ee \
FROM `tbl_products` P JOIN `tbl_category` C ON P.`category_id` = C.`id` \
WHERE C.`category_name` LIKE ? OR P.`product_code` LIKE ? OR P.`product_name` LIKE ?
SEARCH_PRODUCT_BY_CATEGORY_CODE_AND_NAME_TWOWORDS_ORDERED=SELECT P.id AS aa, \
P.product_code AS bb, C.`category_name` AS cc, P.product_name AS dd, FORMAT(P.product_price, 2) AS ee \
FROM `tbl_products` P JOIN `tbl_category` C ON P.`category_id` = C.`id` \
WHERE C.`category_name` LIKE ? OR P.`product_code` LIKE ? OR P.`product_name` LIKE ? \
OR C.`category_name` LIKE ? OR P.`product_code` LIKE ? OR P.`product_name` LIKE ?

swamisantosh · Aug 28, 2021

http://127.0.0.1:19800/v1/category/1
{
"r": [],
"s": "error",
"e": "Error Execute Query",
"m": null
}

d:\pyhoon\WebApi\Objects
i removed webapi.db file the above issues got resolved.
using the debuging, what was issue, i found that, if the sqlite database it does not recreate.

aeric · Aug 28, 2021

swamisantosh said:
http://127.0.0.1:19800/v1/category/1
{
"r": [],
"s": "error",
"e": "Error Execute Query",
"m": null
}

d:\pyhoon\WebApi\Objects
i removed webapi.db file the above issues got resolved.

webapi.db is SQLite database. If you are still using SQLite, it will recreate for you when you compile again.

aeric · Aug 28, 2021

swamisantosh said:
http://127.0.0.1:19800/v1/category/1
{
"r": [],
"s": "error",
"e": "Error Execute Query",
"m": null
}

d:\pyhoon\WebApi\Objects
i removed webapi.db file the above issues got resolved.
using the debuging, what was issue, i found that, if the sqlite database it does not recreate.

I am not sure how deleting the sqlite file would solve the issue. The error was handled by try-catch and you can find the exact problem (LastException) by reading the logs while debugging. As I stated above, I have done a test to send POST request using the payload with invalid comma sign which caused the RequestData read invalid data. Maybe I should have validated the Map initialized from the RequestData. In you case, I am not sure how you produce the error. Since you already able to resolved the issue then it is good and I assume everything is good to go.

Until we found a new bug, I hope the current version is a good template to start your own project. I encourage anyone to modify this template and come out an improved version. For myself, I would add back the user token, API key and SMTP features for my own use. I am not sharing it because a template should be minimalist and serve as a starting point for own customization.

Thanks everyone for the likes and testing this template. ??

Don’t worry, I will keep answering your questions if you have one about this template. ?

Share My Creation [Project Template] Web API Server

Attachments

Expert

Expert

Expert

Expert

Expert

Expert

Expert

Expert

Expert

Expert

Expert

Active Member

Member

Expert

Expert

Expert

Member

Expert

Expert

Similar Threads