webapi returns variables in JSON using snake case and I need camelCase

[csdougliss]

Precondition (*)

Magento 2.3.x

Summary (*)

I want to return JSON in camelCase in my custom webapi.xml and interface that I have created.
There is no way to configure in webapi.xml the format that you wish to use.

By default M2 will return data like so: server_transaction_id but my third party JavaScript is expecting serverTransactionId for example.

Secondly, It is also rather annoying to have to create an interface to do this instead of just being able to use json_encode the data. Using json_encode is not the solution as you end up with \ in the format.

See below:

Examples (*)

interface Check3dsVersionInterface
{
    /**
     * @return string
     */
    public function getServerTransactionId();

    /**
     * @param string $serverTransactionId
     * @return $this
     */
    public function setServerTransactionId($serverTransactionId);

webapi.xml:

<route url="/V1/xx-payments/:cartId/check-3ds-version" method="POST">
        <service class="xx\xx\Api\xxServiceInterface" method="check3dsVersion"/>
        <resources>
            <resource ref="anonymous" />
        </resources>
    </route>

Proposed solution

In webapi.xml, it would be useful to specify the format of the json, for example to return as camelCase or as it is currently which is underscores

[m2-assistant]

Hi @craigcarnell. Thank you for your report.
To help us process this issue please make sure that you provided the following information:

• Summary of the issue
• Information on your environment
• Steps to reproduce
• Expected and actual results

Please make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, please, add a comment to the issue:

@magento give me 2.3-develop instance - upcoming 2.3.x release

For more details, please, review the Magento Contributor Assistant documentation.

@craigcarnell do you confirm that you were able to reproduce the issue on vanilla Magento instance following steps to reproduce?

• yes
• no

---

• Join Magento Community Engineering Slack and ask your questions in #github channel.

[m2-assistant]

Hi @engcom-Charlie. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).

  Details

  If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.

• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.

• 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• 4. Verify that the issue is reproducible on 2.3-develop branch

  Details

  - Add the comment @magento give me 2.3-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.3-develop branch, please, add the label Reproduced on 2.3.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

• 5. Add label Issue: Confirmed once verification is complete.

• 6. Make sure that automatic system confirms that report has been added to the backlog.

[magento-engcom-team]

✅ Confirmed by @engcom-Charlie
Thank you for verifying the issue. Based on the provided information internal tickets MC-20328 were created

Issue Available: @engcom-Charlie, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.

[jayankaghosh]

I am working on this

[m2-assistant]

Hi @jayankaghosh. Thank you for working on this issue.
Looks like this issue is already verified and confirmed. But if you want to validate it one more time, please, go though the following instruction:

• 1. Add/Edit Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• 2. Verify that the issue is reproducible on 2.3-develop branch

  Details

  - Add the comment @magento give me 2.3-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.3-develop branch, please, add the label Reproduced on 2.3.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

• 3. If the issue is not relevant or is not reproducible any more, feel free to close it.

---

• Join Magento Community Engineering Slack and ask your questions in #github channel.

[jayankaghosh]

@craigcarnell instead of specifying whether to render in snake_case or CamelCase, which would again be restrictive, why don't we make sort of a map wherein through di.xml we can specify which field of which class should be called what?

[csdougliss]

@jayankaghosh Whatever works is good with me 👍

[mlambley]

One can always hack the field namer. Works well enough, although I agree that an elegant solution would be preferred.

<!--di.xml-->
<type name="Magento\Framework\Reflection\FieldNamer">
    <plugin name="my_field_namer" type="Vendor\Project\Plugin\FieldNamer"/>
</type>

//Plugin/FieldNamer.php
use Magento\Framework\Api\SimpleDataObjectConverter;
use Magento\Framework\Reflection\FieldNamer as Subject;

class FieldNamer
{
    public function aroundGetFieldNameForMethodName(
        Subject $subject,
        callable $proceed,
        $methodName
    ) {
        if (substr($methodName, 0, 2) === Subject::IS_METHOD_PREFIX) {
            return SimpleDataObjectConverter::snakeCaseToCamelCase(substr($methodName, 2));
        } elseif (substr($methodName, 0, 3) === Subject::HAS_METHOD_PREFIX) {
            return SimpleDataObjectConverter::snakeCaseToCamelCase(substr($methodName, 3));
        } elseif (substr($methodName, 0, 3) === Subject::GETTER_PREFIX) {
            return SimpleDataObjectConverter::snakeCaseToCamelCase(substr($methodName, 3));
        }
    }
}

You will need to adjust your data object fields accordingly

interface ProductDataResponseInterface
{
    const STOCK_ITEM_ID = 'stockItemID';
    const STOCK_CATEGORIES = 'stockCategories';
//...etc
}

EDIT: This solution doesn't work because it's too broad. You would need to tailor this such that a different implementation of Reflection\FieldNamer is used only in the places where you need it to be.

[tuyennn]

@magento-engcom-team What is the current status of this ticket

[nikolasr200]

One can always hack the field namer. Works well enough, although I agree that an elegant solution would be preferred.

<!--di.xml-->
<type name="Magento\Framework\Reflection\FieldNamer">
    <plugin name="my_field_namer" type="Vendor\Project\Plugin\FieldNamer"/>
</type>

//Plugin/FieldNamer.php
use Magento\Framework\Api\SimpleDataObjectConverter;
use Magento\Framework\Reflection\FieldNamer as Subject;

class FieldNamer
{
    public function aroundGetFieldNameForMethodName(
        Subject $subject,
        callable $proceed,
        $methodName
    ) {
        if (substr($methodName, 0, 2) === Subject::IS_METHOD_PREFIX) {
            return SimpleDataObjectConverter::snakeCaseToCamelCase(substr($methodName, 2));
        } elseif (substr($methodName, 0, 3) === Subject::HAS_METHOD_PREFIX) {
            return SimpleDataObjectConverter::snakeCaseToCamelCase(substr($methodName, 3));
        } elseif (substr($methodName, 0, 3) === Subject::GETTER_PREFIX) {
            return SimpleDataObjectConverter::snakeCaseToCamelCase(substr($methodName, 3));
        }
    }
}

You will need to adjust your data object fields accordingly

interface ProductDataResponseInterface
{
    const STOCK_ITEM_ID = 'stockItemID';
    const STOCK_CATEGORIES = 'stockCategories';
//...etc
}

EDIT: This solution doesn't work because it's too broad. You would need to tailor this such that a different implementation of Reflection\FieldNamer is used only in the places where you need it to be.

I made some changes in the proposed solution, and worked for me!
One of the changes, was to use afterGetFieldNameForMethodName instead of around, and then iterate through a list of qualified methodNames to retrieve them the way that i needed.

[ilnytskyi]

would be helpful to preseserve camel case in some cases

[tuyennn]

@magento I am working on this

[jakwinkler]

@tuyennn any progress ?

[tuyennn]

@tuyennn any progress ?

@jakwinkler you see the pull request, it was Priority: P4 and no one from Adobe is gonna review it, soon. lol

[ilnytskyi]

@jakwinkler it looks like we can achieve similar results using the output processors.

as introduced in this commit 89fb372

the only disadvantage is that current implementation allows only one processor per class.

But unless we want to modify core interfaces, custom ones should be safe.

Ultimately we can hack those outputs via plugins - for Magento\Framework\Reflection\DataObjectProcessor

It even looks like we can add custom attributes directly to the output with this approach.