Stack Overflow
Stack Overflow

Questions tagged [enunciate]

Enunciate is an engine for dramatically enhancing your Java Web service API.

Enunciate is a tool that can be used to automatically generate REST documentation by using JAX-RS and javadoc annotations. This can be integrated with build technologies such as ant, maven, and gradle.

140 questions
16
votes
2 answers

Can I use a Maven plugin (enunciate) in Gradle?

I have a maven plugin called enunciate that generates nice API documentation. I'd rather use Gradle as my build tool but it looks like it's limited in this aspect or maybe I just don't know how to use it. I'm wondering if it's possible to use a…
Chip
  • 1,439
  • 3
  • 15
  • 29
11
votes
2 answers

TypeHint for collection in Enunciate

I have some REST services (consuming and producing application/json) and I use @TypeHint to generate documentation. Now I have something like this: import javax.ws.rs.core.Response; ... @Path("/path") public class MyClass { @GET …
ROMANIA_engineer
  • 54,432
  • 29
  • 203
  • 199
11
votes
1 answer

Swagger isn't smart enough to handle anonymous types (such as maps)

I'm using enunciate to generate Swagger documentation for a REST API. One of my legacy beans contains a Map, and Swagger complains about this: [INFO] --- maven-enunciate-plugin:1.27:docs (default) @ foo-api --- [INFO] initializing enunciate. [INFO]…
Josh Glover
  • 25,142
  • 27
  • 92
  • 129
10
votes
4 answers

How do you document a REST API?

How do you document a REST API? Not just the documentation of what the resources are, but really what is the data that gets sent in the request and what the data is that gets sent back in the response. It is not useful enough to know that something…
BestPractices
  • 12,738
  • 29
  • 96
  • 140
10
votes
2 answers

How to Generate REST Docs with Enunciate for a Spring-Jersey Project?

I'm struggling with something that I thought is quite simple - to generate documentation for a set of already existing REST services, which are basically just POJOs annotates with JAX-RS annotations. I'm using Jersey as an implementation provider.…
Vladimir Tsvetkov
  • 2,983
  • 3
  • 26
  • 36
9
votes
1 answer

How to Include the format of the JSON Response Body in the docs generated by Enunciate?

Currently Enunciate generates the REST API documentation, but the Response Body doesn't contain the information about the JSON structure of the response. In my understanding, if I include the classes with the data entities that are…
Vladimir Tsvetkov
  • 2,983
  • 3
  • 26
  • 36
8
votes
1 answer

java.lang.NoClassDefFoundError: com/sun/mirror/apt/AnnotationProcessorFactory when execute Enunciate ant task

I received the following stack trace when attempting to use Enunciate to generate documentation for a Java project. I am using JDK 1.8.0_25 and Enunciate 1.30 RC1. BUILD FAILED C:\dev\PayWay\make\build.xml:882: java.lang.NoClassDefFoundError:…
WW.
  • 23,793
  • 13
  • 94
  • 121
8
votes
1 answer

maven-enunciate-plugin on java 1.8 as apt now removed from latest JDK (i.e. java annotation processing tool)

Question is how to get java 1.8 and maven-enunciate-plugin to work together ? With maven plugin org.codehaus.enunciate version 1.29 and OSX JDK 1.7.0_25 all is good. Enunciate depends on apt and I see this runtime warning in 1.7.0_25 [INFO]…
k1eran
  • 4,492
  • 8
  • 50
  • 73
5
votes
2 answers

How do I change the REST context generated by enunciate?

I have the following annotation in my RESTEasy code: @Path("/v1/authenticateService") Enunciate generates a "Mount Point" in the documentation as: /rest/v1/authenticateService/authenticate I have tried using the following in my enunciate.xml, to…
Karen
  • 51
  • 1
  • 3
5
votes
1 answer

Can Enunciate generate docs for an API that handles generic types?

Given an abstract, generic Resource class and a concrete implementation: public abstract class AbstractResource { @Autowired private SomeService service; @Path("/{id}") @GET public T get(@PathParam("id") String id) { …
Jeremy Ross
  • 11,544
  • 3
  • 36
  • 36
5
votes
2 answers

Modify Enunciate generated configuration file to use the latest jackson library for CXF

Enunciate generates the cxf-jaxrs-servlet.xml file automatically and specifies: org.codehaus.jackson.jaxrs.JacksonJaxbJsonProvider as the JAX-RS provider. This class has changed to com.fasterxml.jackson.jaxrs.JacksonJaxbJsonProvider in the latest…
xesxz
  • 131
  • 1
  • 4
4
votes
1 answer

Generate java client libraries using Enunciate

I have a couple of RESTful webservices i want to document using Enunciate 1.25 using Maven. If i build without the custom enunciate.xml, all the client libraries are built as expected. ... …
n002213f
  • 7,805
  • 13
  • 69
  • 105
4
votes
3 answers

using Enunciate with Maven/multiple modules

I have multiple Maven modules that expose various REST for my service. On top of that, I have an (almost empty) module, called project-docs, that I want to use and generate an aggregated Enunciate api documentation. Unfortunately, Enunciate really…
Alex Dobjanschi
  • 173
  • 1
  • 13
4
votes
0 answers

enunciate Enum with custom value or property

I am now encountering the problem when generating Enum with custom properties. In Project A, i build a API-webservice. I use enunciate-maven-plugin (version 2.12.1) to generate swagger documentation from Java code. When enunciate-maven-plugin runs,…
anhquan
  • 1,338
  • 14
  • 21
4
votes
1 answer

Generating Swagger JSON for Spring MVC: Springfox or Enunciate

If you want to generate Swagger UI documantation for your Spring MVC project, basically you have two options: Enunciate and SpringFox. I dived into the subject but did not find a single opinion which one is better. From my perspective Enunciate…
user1921819
  • 3,290
  • 2
  • 22
  • 28
1
2 3
…
9 10