Code On Time: REST

Thursday, April 21, 2022Print Subscribe

Values of Binary Large Objects (BLOBs) are represented as resource URLs in the data. User identity must be specified in the Authorization header to get or change a BLOB. Hypermedia links to replace or delete BLOB values are included. Developers submit binary data as fields in the body property of the $app.restful method argument or as the named values in the multipart/form-data of HTTP requests.

Work with the BLOB resources like a pro.

RESTful API Engine identifies the user automatically when the host application is making a request. The cookie with the self-encrypted user access token provides the identity information.

Postman shows the BLOB fetched from the resource with the authorization key specified in the "x-api-key" query parameter. RESTful API Engine requires an access token or authorization key to be specified explicitly by the external applications.

The standalone single page application fetches the image of the product category on-demand when the category name is clicked. The app follows the hypermedia links to find the product category "picture" field value.

Labels: BLOB, REST, RESTful, RESTful Workshop

Saturday, March 19, 2022Print Subscribe

Lesson: Custom Actions With Hypermedia

The REST API Level 2 and above must support HTTP methods (verbs) in resource handling. For example, the request with the GET method is expected to return the resource data while the request with the PATCH method is expected to modify some of its fields. The number of HTTP verbs is limited and will not cover all possible scenarios of data manipulation.

Enhance the RESTful API of applications with custom actions to go beyond CRUD.

Confirmation controller "SellPrompt" presents the user with an option to sell 1, 5, or 10 units of a product with a single touch. The "Other" option allows entering the arbitrary quantity of units to sell. The prompt is displayed when users press the "Sell" button in the product form.

RESTful API Engine makes the custom action "sell" available to the client apps. The parameters of the action are specified in the "parameters" key of the payload. The new state of the resource is returned in the response.

Labels: Business Rules, Custom Actions, Reports, REST, RESTful, RESTful Workshop

Tuesday, March 15, 2022Print Subscribe

RESTful Workshop Lessons

This workshop is designed to empower both individual developers and teams to create amazing enterprise-quality backends for mobile and web applications. Zero experience and no code is required to provide your data with the REST API conforming to the Level 3 of Richardson Maturity Model with the built-in OAuth 2.0 and Open ID Connect.

Follow the purposefully constructed lessons that will build up your confidence and help master the RESTful API development. You will begin by creating the backend application and make several embedded single-page apps. You will learn to configure the backend to act as an OAuth 2.0 server. You will create the standalone single-page app that can be hosted on any web server and operating system. It will interact with the RESTful API of the backend application to authenticate users and fetch data. You will learn how to use the app created with Code On Time to provide the backend for a generic device with the limited input capabilities. The built-in Device Authorization Flow makes it possible to integrate your apps into the physical world of IoT and make them future-proof.

Learn to build RESTful applications with the self-documenting API and amazing front-end.

Reading Pane split view in the application created with Code On Time.

An example of the RESTful resource data with the embedded hypermedia.

Labels: OAuth2, REST, RESTful, RESTful Workshop

REST

Learn how to fetch the BLOBs, pass their values in the CRUD requests, and manipulate BLOBs in the singleton resource fields.