ABAP JSON Processing: Serialization and Deserialization

TYPES: BEGIN OF ty_customer,
         id        TYPE i,
         name      TYPE string,
         email     TYPE string,
         active    TYPE abap_bool,
       END OF ty_customer.

DATA: ls_customer TYPE ty_customer.

ls_customer = VALUE #(
  id     = 1001
  name   = 'Max Mustermann'
  email  = '[email protected]'
  active = abap_true
).

" Convert structure to JSON
DATA(lv_json) = /ui2/cl_json=>serialize(
  data        = ls_customer
  compress    = abap_true    " No null values/empty fields
  pretty_name = /ui2/cl_json=>pretty_mode-camel_case
).

WRITE: / lv_json.
" {"id":1001,"name":"Max Mustermann","email":"[email protected]","active":true}

DATA: lv_json TYPE string.
DATA: ls_customer TYPE ty_customer.

lv_json = '{"id":1001,"name":"Max Mustermann","email":"[email protected]","active":true}'.

" Convert JSON to structure
/ui2/cl_json=>deserialize(
  EXPORTING
    json = lv_json
    pretty_name = /ui2/cl_json=>pretty_mode-camel_case
  CHANGING
    data = ls_customer
).

WRITE: / 'ID:', ls_customer-id.
WRITE: / 'Name:', ls_customer-name.
WRITE: / 'Email:', ls_customer-email.

DATA: lt_customers TYPE TABLE OF ty_customer.

lt_customers = VALUE #(
  ( id = 1 name = 'Miller'   email = '[email protected]'  active = abap_true )
  ( id = 2 name = 'Schmidt'  email = '[email protected]' active = abap_true )
  ( id = 3 name = 'Weber'    email = '[email protected]'   active = abap_false )
).

DATA(lv_json) = /ui2/cl_json=>serialize(
  data        = lt_customers
  compress    = abap_true
  pretty_name = /ui2/cl_json=>pretty_mode-camel_case
).

WRITE: / lv_json.
" [{"id":1,"name":"Miller",...},{"id":2,...},{"id":3,...}]

DATA: lv_json TYPE string.
DATA: lt_customers TYPE TABLE OF ty_customer.

lv_json = '[{"id":1,"name":"A"},{"id":2,"name":"B"},{"id":3,"name":"C"}]'.

/ui2/cl_json=>deserialize(
  EXPORTING json = lv_json
  CHANGING  data = lt_customers
).

LOOP AT lt_customers INTO DATA(ls_cust).
  WRITE: / ls_cust-id, ls_cust-name.
ENDLOOP.

DATA: ls_data TYPE ty_customer.

" Original ABAP names (UPPERCASE)
DATA(lv_json1) = /ui2/cl_json=>serialize(
  data = ls_data
  pretty_name = /ui2/cl_json=>pretty_mode-none
).
" {"ID":1001,"NAME":"Max",...}

" camelCase
DATA(lv_json2) = /ui2/cl_json=>serialize(
  data = ls_data
  pretty_name = /ui2/cl_json=>pretty_mode-camel_case
).
" {"id":1001,"name":"Max",...}

" Lowercase with underscores
DATA(lv_json3) = /ui2/cl_json=>serialize(
  data = ls_data
  pretty_name = /ui2/cl_json=>pretty_mode-low_case
).
" {"id":1001,"name":"Max",...}

TYPES: BEGIN OF ty_address,
         street  TYPE string,
         city    TYPE string,
         zip     TYPE string,
       END OF ty_address.

TYPES: BEGIN OF ty_person,
         name    TYPE string,
         age     TYPE i,
         address TYPE ty_address,
       END OF ty_person.

DATA: ls_person TYPE ty_person.

ls_person = VALUE #(
  name = 'Max'
  age  = 30
  address = VALUE #(
    street = 'Main Street 1'
    city   = 'Berlin'
    zip    = '10115'
  )
).

DATA(lv_json) = /ui2/cl_json=>serialize(
  data        = ls_person
  pretty_name = /ui2/cl_json=>pretty_mode-camel_case
).

" {"name":"Max","age":30,"address":{"street":"Main Street 1","city":"Berlin","zip":"10115"}}

DATA(lv_json) = /ui2/cl_json=>serialize(
  data          = ls_customer
  pretty_name   = /ui2/cl_json=>pretty_mode-camel_case
  format_output = abap_true  " Indented/formatted
).

" {
"   "id": 1001,
"   "name": "Max Mustermann",
"   "email": "[email protected]"
" }

DATA: lv_json TYPE string.
DATA: lr_data TYPE REF TO data.
FIELD-SYMBOLS: <data> TYPE any.

lv_json = '{"name":"Max","age":30,"items":[1,2,3]}'.

" Parse generically
/ui2/cl_json=>deserialize(
  EXPORTING json = lv_json
  CHANGING  data = lr_data
).

" Result is a dynamic structure
ASSIGN lr_data->* TO <data>.

TYPES: BEGIN OF ty_abap_struct,
         customer_id   TYPE i,
         customer_name TYPE string,
       END OF ty_abap_struct.

DATA: ls_data TYPE ty_abap_struct.

" JSON with different field names
DATA: lv_json TYPE string VALUE '{"customerId":1,"customerName":"Test"}'.

" Name mapping via PRETTY_NAME
/ui2/cl_json=>deserialize(
  EXPORTING
    json        = lv_json
    pretty_name = /ui2/cl_json=>pretty_mode-camel_case
  CHANGING
    data        = ls_data
).

WRITE: / ls_data-customer_id, ls_data-customer_name.

" Only available in ABAP Cloud / Steampunk
DATA: ls_customer TYPE ty_customer.

ls_customer = VALUE #( id = 1 name = 'Test' email = '[email protected]' ).

" Serialize
DATA(lv_json) = xco_cp_json=>data->from_abap( ls_customer
  )->apply( VALUE #(
    ( xco_cp_json=>transformation->camel_case )
  )
  )->to_string( ).

" Deserialize
xco_cp_json=>data->from_string( lv_json
  )->apply( VALUE #(
    ( xco_cp_json=>transformation->underscore_case )
  )
  )->write_to( REF #( ls_customer ) ).

" Create transformation Z_JSON_CUSTOMER (STRANS)

" <?sap.transform simple?>
" <tt:transform xmlns:tt="http://www.sap.com/transformation-templates"
"               template="main">
"   <tt:root name="CUSTOMER"/>
"   <tt:template>
"     <object>
"       <str name="id"><tt:value ref="CUSTOMER.ID"/></str>
"       <str name="name"><tt:value ref="CUSTOMER.NAME"/></str>
"     </object>
"   </tt:template>
" </tt:transform>

DATA: ls_customer TYPE ty_customer,
      lv_json     TYPE string.

ls_customer = VALUE #( id = 1 name = 'Max' ).

" ABAP to JSON
CALL TRANSFORMATION z_json_customer
  SOURCE customer = ls_customer
  RESULT XML lv_json
  OPTIONS data_refs = 'embedded'.

" JSON to ABAP
CALL TRANSFORMATION z_json_customer
  SOURCE XML lv_json
  RESULT customer = ls_customer.

DATA: lv_response TYPE string,
      ls_result   TYPE ty_api_response.

" HTTP Request
DATA(lo_client) = cl_web_http_client_manager=>create_by_http_destination(
  i_destination = cl_http_destination_provider=>create_by_url( 'https://api.example.com' )
).

DATA(lo_request) = lo_client->get_http_request( ).
lo_request->set_uri_path( '/api/customers/1' ).

DATA(lo_response) = lo_client->execute( if_web_http_client=>get ).
lv_response = lo_response->get_text( ).

" Parse JSON response
/ui2/cl_json=>deserialize(
  EXPORTING json = lv_response
  CHANGING  data = ls_result
).

lo_client->close( ).

TYPES: BEGIN OF ty_request,
         action  TYPE string,
         payload TYPE string,
       END OF ty_request.

DATA: ls_request TYPE ty_request.

ls_request = VALUE #(
  action  = 'create'
  payload = 'test data'
).

" Create request body
DATA(lv_json_body) = /ui2/cl_json=>serialize(
  data        = ls_request
  pretty_name = /ui2/cl_json=>pretty_mode-camel_case
).

" HTTP POST
DATA(lo_client) = cl_web_http_client_manager=>create_by_http_destination(
  i_destination = cl_http_destination_provider=>create_by_url( 'https://api.example.com' )
).

DATA(lo_request) = lo_client->get_http_request( ).
lo_request->set_uri_path( '/api/process' ).
lo_request->set_header_field( i_name = 'Content-Type' i_value = 'application/json' ).
lo_request->set_text( lv_json_body ).

DATA(lo_response) = lo_client->execute( if_web_http_client=>post ).

DATA: lv_json TYPE string VALUE '{"invalid json'.
DATA: ls_data TYPE ty_customer.

TRY.
    /ui2/cl_json=>deserialize(
      EXPORTING json = lv_json
      CHANGING  data = ls_data
    ).
  CATCH cx_sy_move_cast_error INTO DATA(lx_error).
    WRITE: / 'JSON parsing error:', lx_error->get_text( ).
ENDTRY.

TYPES: BEGIN OF ty_event,
         name       TYPE string,
         event_date TYPE d,
         event_time TYPE t,
         timestamp  TYPE timestamp,
       END OF ty_event.

DATA: ls_event TYPE ty_event.

ls_event = VALUE #(
  name       = 'Meeting'
  event_date = sy-datum
  event_time = sy-uzeit
  timestamp  = utclong_current( )
).

" Standard: Date as YYYYMMDD
DATA(lv_json) = /ui2/cl_json=>serialize(
  data        = ls_event
  pretty_name = /ui2/cl_json=>pretty_mode-camel_case
).

" For ISO format: Custom conversion needed

DATA: lt_ids TYPE TABLE OF i.

lt_ids = VALUE #( ( 1 ) ( 2 ) ( 3 ) ( 4 ) ( 5 ) ).

DATA(lv_json) = /ui2/cl_json=>serialize( data = lt_ids ).
WRITE: / lv_json.  " [1,2,3,4,5]

" Back
DATA: lt_parsed TYPE TABLE OF i.
/ui2/cl_json=>deserialize(
  EXPORTING json = lv_json
  CHANGING  data = lt_parsed
).

TYPES: BEGIN OF ty_nullable,
         name  TYPE string,
         value TYPE i,
       END OF ty_nullable.

DATA: ls_data TYPE ty_nullable.

ls_data = VALUE #( name = 'Test' ).  " value stays initial (0)

" With compress = true: Omit initial values
DATA(lv_compressed) = /ui2/cl_json=>serialize(
  data     = ls_data
  compress = abap_true
).
" {"name":"Test"}

" Without compress: All fields
DATA(lv_full) = /ui2/cl_json=>serialize(
  data     = ls_data
  compress = abap_false
).
" {"name":"Test","value":0}

TYPES: BEGIN OF ty_flags,
         enabled TYPE abap_bool,
         visible TYPE abap_bool,
       END OF ty_flags.

DATA: ls_flags TYPE ty_flags.

ls_flags = VALUE #(
  enabled = abap_true
  visible = abap_false
).

DATA(lv_json) = /ui2/cl_json=>serialize(
  data = ls_flags
  pretty_name = /ui2/cl_json=>pretty_mode-camel_case
).

WRITE: / lv_json.  " {"enabled":true,"visible":false}

" 1. Define types matching the API
TYPES: BEGIN OF ty_api_error,
         code    TYPE string,
         message TYPE string,
       END OF ty_api_error.

TYPES: BEGIN OF ty_api_response,
         success TYPE abap_bool,
         data    TYPE ty_customer,
         error   TYPE ty_api_error,
       END OF ty_api_response.

" 2. Process response
DATA(lv_status) = lo_response->get_status( )-code.
DATA(lv_body) = lo_response->get_text( ).

DATA: ls_response TYPE ty_api_response.
/ui2/cl_json=>deserialize(
  EXPORTING json = lv_body
  CHANGING  data = ls_response
).

IF ls_response-success = abap_true.
  " Process success
ELSE.
  " Handle error
  WRITE: / 'Error:', ls_response-error-message.
ENDIF.