How to render plain JSON (without any additional tag) data in DXA 1.5 java?

Question

We are using Tridion 2013 SP1 with DXA 1.5 java. One of our requirement we want to serve the JSON formated data file( apple-app-site-association ) in my web site.

My component schema has only one rich text field (without Rich Text Formatting) and Only one component presentation is enough for the page. I have published the page in to broker DB. I built the page in CM (apple-app-site-association.json) but When I request the page (http://localhost:9080/apple-app-site-association) without extension.

Note: The page response content type should be "Content-Type: application/json"

The page response should be like this:

http://localhost:9080/apple-app-site-association (without page .json extension)

{
  "applinks": {
    "apps": [],
    "details": [
      {
        "appID": "xxx.com.xx.AccidentToolkit",
        "paths": [
          "/cp/mobile/*"
        ]
      }
    ]
  }
}

Updated:

I have created a schema "CodeSchema" with only one rich text field name "code"(without Rich Text Formatting) I created a component for this shcema it's has JSON data. I have created a page(JSON PT and only one component presentation for my component) I published the page. it's in broker DB.

I'm trying to get the page/component data through my custom controler then return it to my view (jsp):

RegisteredViewModel:

@RegisteredViewModel(viewName = "CodeJSONPage", modelClass = CodeComponentModel.class, controllerName = "AppleAppSiteAssociationController")

Model:

@SemanticEntity(entityName = "Code", vocabulary = SDL_CORE, prefix = "c")
    public class CodeComponentModel extends AbstractEntityModel {

        @JsonProperty("code")
        @SemanticProperty("c:code")
        private RichText code;

        public RichText getCode() {
            return code;
        }

        public void setCode(RichText code) {
            this.code = code;
        }
  }

Controller:

@Controller
@RequestMapping(method = RequestMethod.GET, value="/apple-app-site-association", headers="content-type=application/json")
public class AppleAppSiteAssociationController extends EntityController {

    private static final Logger LOG = LoggerFactory.getLogger(AppleAppSiteAssociationController.class);

    @RequestMapping() 
    public String GetAppleAppSiteAssociationJSON(@RequestHeader("Content-Type") String ContentType, @RequestHeader("Accept") String acceptType, ModelMap modelMap, HttpServletRequest request) {

        // Am trying to get the getCode() data here

        //modelMap.put("entity",  jObjects);
        return "Nationwide/Page/CodeJSONPage";
    }
}

Answer 1

You can create your own Controller with its own route (/apple-app-site-association) and let it return whatever kind of JSON data you need.

UPDATE:

If you don't want to use your own Controller, but use DXA's default Page Controller, you will have to ensure that your CM Pages use an .html file extension; DXA supports extensionless URLs, but it expects the CM Page to always have an .html file extension (even though the published Page Content will actually be JSON).

The default Page Controller will serve JSON (with Content-Type: application/json) if the HTTP request has an Accept: application/json header (or if the request URL contains ?format=json), but the response JSON will represent the entire Page Model.

If you want to have control over the returned JSON, you should create your own Controller. For example, see: https://github.com/sdl/dxa-web-application-java/blob/master/dxa-webapp/src/main/java/org/example/controller/AdminController.java

Answer 2

OK, it is finally getting clear what you want to achieve and how you are trying to achieve it; thanks for providing the additional details, that helps a lot!

I'm still wondering why you are trying to manage raw output JSON in Content Manager (and why you're using a Rich Text Field for that). It seems very error-prone to me. But let's not go there now.

Note that, in general, you shouldn't use DXA's "JSON" Page Template for your CM Pages; that PT is intended for raw JSON files which DXA uses for its settings. Regular DXA Pages use a PT which invokes the "Render Page Content" TBB. This renders a DXA Page Model (JSON), which can be served by the default Page Controller.

However, given what you want to achieve, the simplest approach might be to completely bypass the DXA MVC mechanism for this Page:

• Create a Component Template which outputs the JSON from your Code Component's Rich Text Field
• Create a Page with one Component Presentation based on that CT. Use the DXA "JSON" Page Template like you're currently doing.
  • When you preview or publish this Page, it should contain the raw JSON from your Component.
• Create your own Controller.
  • Don't let it inherit from EntityController; these are intended for use within DXA's MVC mechanism.
  • Let your Controller use the CD API to retrieve the (JSON) content of your Page
  • Let your Controller return this JSON and set the response header Content-Type: application/json

Alternatively, you can let your CT be dynamic. In that case, you don't need a Page at all; your Code Component can be published directly as Dynamic Component Presentation. Your Controller can then use the CD API to retrieve this DCP.

UPDATE:

Examples of how to retrieve Page and DCP content using CD APIs can be found here: https://github.com/sdl/dxa-model-service/blob/master/java/dxa-model-service/dxa-model-service-controller/src/main/java/com/sdl/dxa/modelservice/service/ContentService.java