Is there an API to create a similar Google Directory API service?

Asked

Viewed 50 times

1

I find Google’s Directory API very interesting for bringing together documentation and testing environment in an objective and well organized way.

I wonder if there is a similar plugin that can be added to a Java application to automatically generate that environment. To be clear I would quote Javadoc. Based on the annotations and comments he is able to generate the documentation. That would be a good deal of the content we can find in the Directory API. The testing environment could for the REST functions depend on the REST notation, identify the server URL, and mount the request URL. Javadoc doesn’t contemplate everything.

What I wanted exactly is to ride a Directory API private, where he had as content the documentation of my project.

Does anyone know if there is this ready somewhere or if it is really necessary to create it in hand? If there is, which program or plugin is used to do this?

java rest annotation javadoc
  • 1

    Everything in a single solution I do not know, besides relying on tools you already use, such as Reports generated by default in build as Maven and Gradle. For the documentation/test/mock part of the REST API I recommend taking a look at Swagger

2 answers

0

Apidoc is a library that can be used to generate documentation for Rest services.

In addition to supporting documentation, this tool also includes the sandbox, which is a testing environment that can be used to test the calls themselves.

I used in Symfony, but can also be used in other frameworks or even used without framework, its use is based on Annotations, through "comments" you can document your Rest and also the testing environment.

The library is well complete and has a good documentation (in English), for more information about the library just access the apidoc website, if you are using symfony you can use Nelmioapidocbundle.

The library also allows the customization of the template, for the creation of a custom layout.

0

Maybe the Maven website generator can help you in this task, because it is possible to generate websites with project documentation and additional items, from a look:

Maven - Creating a Site

  • I’m actually looking for a same REST documentation generator. I’ll check out more about this

Browser other questions tagged java rest annotation javadoc

You are not signed in. Login or sign up in order to post.