How to add new fields to M2.4.2 CMS REST API response?

Question

How would I go about adding new custom fields I have created for CMS pages to M2.4.2 CMS REST API responses (and possibly even search/filtering)?

For example, if I want to add new fields to retrieving a single CMS page response, and retrieving a multiple CMS pages meeting certain criteria (possibly even filtering by these new fields if possible?) response?

For example, here are my new fields (a text field and a date field) which are saved in the database: https://i.sstatic.net/0tqea.png

I added them in InstallSchema: https://i.sstatic.net/utfe9.png

and in UpgradeSchema: https://i.sstatic.net/gukqz.png

I also added them in the adminhtml ui_component xml: https://i.sstatic.net/HoMgW.png

If someone could help me retrieve these new fields (and maybe even search by these new fields) in API call responses (get single CMS page and get multiple CMS pages) that would be amazing.

For example, I want to add new fields to this REST API response: https://i.sstatic.net/XDRLF.png

Also I would like to add new fields to this REST API response: https://i.sstatic.net/Ryljp.png

Thank you.

Answer 1

You can use a plugin to add value in API's return result

The handler function in the

api /V1/cmsPage/:pageId is vendor/magento/module-cms/Model/PageRepository.php:217

you should use the after plugin in the function getById, then use the setData function to add your value to the returned result