NPE if the ApiResponseObject is missing

[jameselsey]

If you forget to add the ApiResponseObject to a controller method, you'll get a javascript alert on the jsondoc-ui and will see this in the log:

java.lang.NullPointerException
    org.jsondoc.springmvc.scanner.SpringJSONDocScanner.getApiResponseObject(SpringJSONDocScanner.java:116)
    org.jsondoc.springmvc.scanner.SpringJSONDocScanner.mergeApiMethodDoc(SpringJSONDocScanner.java:52)
    org.jsondoc.core.util.AbstractJSONDocScanner.getApiMethodDoc(AbstractJSONDocScanner.java:143)
    org.jsondoc.core.util.AbstractJSONDocScanner.getApiMethodDocs(AbstractJSONDocScanner.java:122)
    org.jsondoc.core.util.AbstractJSONDocScanner.getApiDoc(AbstractJSONDocScanner.java:110)
    org.jsondoc.core.util.AbstractJSONDocScanner.getApiDocs(AbstractJSONDocScanner.java:93)
    org.jsondoc.core.util.AbstractJSONDocScanner.getApiDocsMap(AbstractJSONDocScanner.java:315)
    org.jsondoc.core.util.AbstractJSONDocScanner.getJSONDoc(AbstractJSONDocScanner.java:80)
    org.jsondoc.springmvc.controller.JSONDocController.getApi(JSONDocController.java:32)
    sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
    sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
    java.lang.reflect.Method.invoke(Method.java:597)
    org.springframework.web.method.support.InvocableHandlerMethod.invoke(InvocableHandlerMethod.java:215)
    org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:132)
    org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:104)
    org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandleMethod(RequestMappingHandlerAdapter.java:749)
    org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:689)
    org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:83)
    org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:938)
    org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:870)
    org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:961)
    org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:852)
    javax.servlet.http.HttpServlet.service(HttpServlet.java:620)
    org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:837)
    javax.servlet.http.HttpServlet.service(HttpServlet.java:727)

The offending method is

private ApiResponseObjectDoc getApiResponseObject(Method method, ApiResponseObjectDoc apiResponseObjectDoc) {
        if(method.getReturnType().isAssignableFrom(ResponseEntity.class)) {
            apiResponseObjectDoc.getJsondocType().getType().remove(0);
        }

        return apiResponseObjectDoc;
    }

It would be best to null check the response object and display this in another way, as it's not obvious unless you check logs then debug to find which method is missing the annotation (if you have lots, like I do)

[fabiomaffioletti]

Thank you, I'll look into it

[fabiomaffioletti]

Thank you, I'll look into it

[fabiomaffioletti]

Not able to reproduce. Please give some more info or share code snippets.

[fabiomaffioletti]

Not able to reproduce. Please give some more info or share code snippets.

[jameselsey]

Create a controller, annotate it with Api

Create some controller methods, annotate those with ApiMethod and ApiResponseObject

Pick one controller and remove the ApiResponseObject annotation

Try to view the jsondoc ui, you should get a js alert box and a 500 in the js console

[jameselsey]

Create a controller, annotate it with Api

Create some controller methods, annotate those with ApiMethod and ApiResponseObject

Pick one controller and remove the ApiResponseObject annotation

Try to view the jsondoc ui, you should get a js alert box and a 500 in the js console

[fabiomaffioletti]

Still not able to reproduce. I created a temporary controller in the demo project (http://jsondoc.eu01.aws.af.cm/jsondoc.jsp) to show that even if you don't specify the annotation, everything still works. Take a look at the code here https://github.com/fabiomaffioletti/jsondoc-samples/blob/master/jsondoc-sample-springmvc/src/main/java/org/jsondoc/sample/controller/JamesController.java and browse the documentation on the demo website.

[fabiomaffioletti]

Still not able to reproduce. I created a temporary controller in the demo project (http://jsondoc.eu01.aws.af.cm/jsondoc.jsp) to show that even if you don't specify the annotation, everything still works. Take a look at the code here https://github.com/fabiomaffioletti/jsondoc-samples/blob/master/jsondoc-sample-springmvc/src/main/java/org/jsondoc/sample/controller/JamesController.java and browse the documentation on the demo website.