Atlassian REST API Browser doesn't show Java Doc Comments

Confluence Development Confluence Data Center
,
1

Hi REST Service Developers,

I am trying to generate documentation from the Javadoc comments of a REST Service (for Confluence 9.1.x with Java 17) to be rendered in the Atlassian REST API Browser (RAB).

The problem is already described in Atlassian REST API Browser dosn't show Java Doc Comments. Although the API is properly documented in Javadoc, the RAB shows nothing.

When starting AMPS/Atlassian SDK 9.1.1, I get the following written to the build output:

[INFO] --- confluence:9.1.1:generate-rest-docs (default-generate-rest-docs) @ <SNIP> ---
[INFO] Skipping REST documentation generation as it is not supported on Java 13 or greater

I have found that the issue is reported with RAB-33 and AMPS-1668 explains why this function has been removed:

If Java 13 or greater is used for generating rest documentation, 
it will fail because in JDK 13 the support to com.sun.javadoc API was removed.

Unfortunately the current documentation does not provide any information on how we are supposed to handle this:

Am i missing something? Is there some configuration trick or other tooling that would provide the documentation in the Atlassian REST API Browser? What is Atlassian’s recommendation here?

Cheers,
Robert

2

From the documentation you have linked:

You can also include a custom application-doc.xml file in your src/main/resources/ folder that can provide any custom static documentation in the WADL file.

Have you tried this?

Never used it. Maybe provide an update here, if you got it working.

1 Like
3

We’ve moved from using this to Swagger and putting our REST API documentation on developer.atlassian.com. We’re no longer using REST API Browser internally, with time we’ll EoL it. I recommend instead doing the same, use swagger to generate the docs and host that on your website.

Generating that file that RAB picks up relied on a lot of patching we did to a Jersey 1 module, even with that the RAB never really worked right and was hard to generate docs for. It was a cool idea 10+ years when it was built, but the industry has moved on.

1 Like