The #1 API Project for Grails & Springboot: view

Springboot / Grails API Plugin | BeApi(tm) Api Framework

About the Bintray Shutdown

Bintray is shutting down but they have stated that they will maintain all repos (at least until 2022). Some Grails projects have moved and have created a few issues and we are forking and porting them as we speak (expected fix by 5/12).

We are continuing to maintain the project and will even past the Grails 3.0 deprecation date; we are porting everything to spring-boot and will have a MUCH FASTER and LEANER build by the end of the year.

Benchmarks : view

Latest Version: 2.0.40

Stable/Latest Profile Version: 2.0.40

❤️ Sponsor on GitHub

Project Cost Evaluation

───────────────────────────────────────────────────────────────────────────────
Language                 Files     Lines   Blanks  Comments     Code Complexity
───────────────────────────────────────────────────────────────────────────────
HTML                        86     32886     5066      3922    23898          0
Groovy                      45     10181     1520      2084     6577        933
Markdown                    10       474      133         0      341          0
Properties File              5        40        3         2       35          0
YAML                         4       297       12         4      281          0
BASH                         2       338       40        44      254         44
Batch                        2       168       46         0      122         40
CSS                          2      4612      974         2     3636          0
Gradle                       2       381       72        61      248          0
License                      2       228       34         0      194          0
gitignore                    2        22        0         0       22          0
───────────────────────────────────────────────────────────────────────────────
Total                      162     49627     7900      6119    35608       1017
───────────────────────────────────────────────────────────────────────────────
Estimated Cost to Develop (organic) $1,150,059
Estimated Schedule Effort (organic) 14.503999 months
Estimated People Required (organic) 7.044472
───────────────────────────────────────────────────────────────────────────────
Processed 2293189 bytes, 2.293 megabytes (SI)
───────────────────────────────────────────────────────────────────────────────

Documentation - http://orubel.github.io/Beapi-API-Framework/

Forums - http://beapi.freeforums.net/

New App Installation

Install Grails 3.X normally then edit your 'USER_HOME/.grails/settings.groovy' file to look like the following:


grails {
  profiles {
    repositories {
      maven {
        url =  "https://dl.bintray.com/orubel/profiles/"
        snapshotsEnabled = false
      }
      grailsCentral {
        url = "https://repo.grails.org/grails/core"
        snapshotsEnabled = true
      }
    }
  }
}

and then run...

grails create-app name_of_your_app --profile org.grails.profiles:beapi-profile:2.0.40

Frontend Implementation - https://github.com/orubel/beapi_frontend

❤️ Sponsor on GitHub

Description

The BeAPI Framework is a Springboot / Grails API plugin providing a full featured API Automation framework and an AVERAGE response time per call of 0.25 milliseconds per request (Google requires their calls to be UNDER 200 ms).

Some features include:

Automated Batching: all endpoints are batchable by default with AUTH ROLES assignable to restrict access. Batching can also be TOGGLED to turn this feature ON/OFF per endpoint.
Built-in CORS: Cross Origin Request handling secures all endpoints from domains that you don't want. Added capability for securing different network groups
JWT Tokens: JWT Token handling for Javascript frontends to allow or better abstraction of the VIEW layer
Schema Management/Caching: Manage your the state for all your endpoints through the IO State files. Unlike Swagger/OpenApi, the data associated with functionality for REQUEST/RESPONSE can be shared from a centralized cache and thus can be synchronized making it more secure, stable, faster and flexible. You can make changes to your apis, security and definitions on the fly all without taking your servers down.
Automated Web Hooks: Enables secured Web Hooks for any endpoint so your developers/users can get push notification on updates.
Throttling & Rate/Data Limits: Data Limits/Rate limits and Throttling for all API's through easy to configure options
Autogenerated APIDocs: Unlike Swagger/OpenApi which shows the ApiDocs regardless of ROLE, APIDocs are autogenerated based on your ROLE thus showing only the endpoints that you have access to.
API Chaining(tm): rather than using HATEOAS to make a request, get a link, make a request, get a link, make a request, etc... api chaining allows for creation of an 'api monad' wherein the output from a related set of apis can be chained client side allowing the output from one api to be accepted as the input to the next and so on and be passed with ONE REQUEST AND ONE RESPONSE. It is handled as a type of BATCH call wherein the backend automates the hand-off and processing.
Automated API Caching: returned resources are cached,stored and updated with requesting ROLE/AUTH. Domains extend a base class that auto update this cache upon create/update/delete. This speeds up your api REQUEST/RESPONSE x10
Built-In Stats Reporting: Statistics on all api calls (and errors) are stored and can be called up at any time for reporting tooling.

FAQ

Q: How hard is this to implement?
A: BeApi is a Grails Plugin and you dont even have to install the plugin. Implementing for a new project is as simple as a one line command (see 'NEW APP INSTALLATION' above)):

grails create-app name_of_your_app --profile org.grails.profiles:beapi-profile:2.0.40

Q: How do I implement the listener for IO state webhook on my proxy/Message queue?
A: It merely requires an endpoint to send the data to. As a side project, I may actually supply a simple daemon in the future with ehCache to do this for people.

orubel / Beapi-API-Framework