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

Version: 2.05
Description: Create Web API Server using B4X template

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.05).b4xtemplate

Depends on:

• WebApiUtils.b4xlib
• MiniORMUtils.b4xlib
• Optional:
  • WebAPIController.jar and WebAPIController.xml

GitHub:

• https://github.com/pyhoon/webapi-2-b4j
• https://github.com/pyhoon/WebApiUtils-B4J
• https://github.com/pyhoon/MiniORMUtils-B4X
• https://github.com/pyhoon/WebApiController-B4J

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)

Release Logs

Spoiler: Version: 2.05

• (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.

Spoiler: Version: 2.04

• (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:

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

Tutorials:

1. Getting Started
2. Download File Example
3. Vue 3 CRUD Example

Live:

• Creating Web API Server with B4X Template

Spoiler: Part 1: Get Started and configure the server

Spoiler: Part 2: Create a controller from scratch

Spoiler: Part 3: Connecting to database

Spoiler: Part 4: Connecting to database using MiniORMUtils

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:

1. @yaqoob
2. @Czampo

---

 

[aeric]

Optional Modules​

1. DataConnector (connect to SQLite, MySQL databases)
2. JSON Web Tokens
3. MinimaList
4. MiniORM
5. Encryption

Optional Filters​

1. CORS
2. BasicAuth
3. JWTAuth

Optional Libraries

1. WebApiController
2. MinimaListController

 

[byz]

不错

 

[aeric]

I am making little progress in token authentication. Still figuring out how to properly use access token and refresh token in browser based Web app, mobile and desktop app.

 

[aeric]

This project has become more complex to handle non-api routes and multi version. I am scrapping beta 2 and rebuild as beta 3.

 

[aeric]

Web API Server (2.00 beta 2)

 

[aeric]

Beta 3 development

 

[aeric]

Web API Server (2.00 beta 3)

It's Open Source !

 

[aeric]

A small issue i.e. I forgot to update the Client ID.

Change line #96 in Main module to following:

AUTH.CLIENT_ID = "web-202301151435-web-api-200.computerise.net"        ' username

Updates: The issue is now fixed in GitHub repo.

 

[aeric]

Beta 4 development

 

[aeric]

Beta 4 development (dashboard)

 

[Davisbc]

Is there a download link for beta 4?
thanks in advance

 

[aeric]

Is there a download link for beta 4?
thanks in advance

No. There are some rough edges.
I don't feel I want to share at this point.

 

[Davisbc]

Thanks for the response. Appreciate the great work

 

[aeric]

I may be wrong.
Does anyone really use my Web API Template?
I have the feeling not much interest on this project. I don't see any discussion or question on the issue in this project. I feel it just a pet project that I am the only one feel good about it and provide no valuable real life use cases.

But...
The fact is I am powering my production apps with this template.

 

[Davisbc]

I am try to use it as the foundation for a data collection app. The mobile collects data and then syncs with the web api. I started using the v1 template. It worked, but I found it difficult to try and convert to my database. I decided to start over and then found the v2 beta. I had to comment the auth code to make it work. from your comments, that part is a work in progress. My use case is an api pack end to update a database and maintain a transaction log. I have to believe it’s a common use case. All the best.

 

[aeric]

I believe v1 and v2 beta 3 have provided the foundation to build any Web API server. What I am adding are just on the implementation of the front end.

The security part in v2 can be ignored as I am actually using Session for log in user instead of JWT token.

Please ask any question if you found any issue.
I know there are some known issues and waiting someone to report.
One of them are usage of comment tags in HelpHandler but it is not really a big issue and won't affect the overall system.

When no one is reporting then I get the feeling no one is using it.

 

[Davisbc]

Thanks. I have a bit more cleanup of the b4a before I plan on working the backend again. That’s why I was asking when you planned on updating the template so I would start with a clean code. Cheers

 

[aeric]

I will release a clean version in the future. Not sure when it is.

 

[Davisbc]

Thanks. i look forward to seeing it. All the best!