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
0
votes
2 answers

Web application with Enunciate: where to put the static resources

I use Enunciate (http://enunciate.codehaus.org/) for our web-service layer and I just want to do something very simple but do not find any documentation. I want to deploy some images and other static resources and to be accessible from e.g…
рüффп
  • 5,172
  • 34
  • 67
  • 113
0
votes
2 answers

Does Enunicate maven plug-in could generate the data model which in other java project?

Would you please help me to fix a problem I met that to use Enunciate maven plug-in? The problem is my domain is in other project, not in API project (not package, but java project), so when generate the documents, there is no data model, but I…
user1421053
  • 1
  • 1
0
votes
2 answers

exlude few rest methods from enunciate doc tool

Im using enunciate to document my REST API. Im able to generate docs properly and have been using it for quite some time. My issue now is.. Ive few Service classes with multiple endpoint methods. public interface UserLoginService { //This method…
srao
  • 11
  • 4
0
votes
1 answer

Add jdoc of custom class to enunciate docs?

I have a Maven-JAX-RS project written in java and using enunciate to automatically generate docs with every build. So far, it works well - he generates api-docs for all REST-Endpoints in my project. Now i have written some util-classes with useful…
jebbie
  • 1,418
  • 3
  • 17
  • 27
0
votes
3 answers

Why do Jars get Excluded from Enunciate's Deployment?

I'm using Enunciate to build a prototype REST api and need to include a jar containing custom code as a library. My Ant Script looks like this:
Randyaa
  • 2,935
  • 4
  • 36
  • 49
0
votes
2 answers

JAXWS-RI module requires an implementation for each service interface

I have service and its implemented interface... My interface has an annotation specifying the service name as name of Service which has implemented that interface .. however the service doesn't have annotation specifying endpoint interface ? So will…
Cycorax12
  • 31
  • 1
  • 5
0
votes
2 answers

Enunciate isn't generating Descriptions from xs:documentation on xs:elements

We're using maven-enunciate-plugin version 1.26.2 and are encountering an issue during the generation of our documentation. We have added comments to our XSDs in the following manner: …
Plenoge
  • 17
  • 8
0
votes
1 answer

enunciate docs issue with Iterable and generics

I’m trying to use enunciate to regenerate documentation for my Jersey-based REST API. Hitting a few stumbling blocks: @GET @Produces(MediaType.APPLICATION_JSON) public Iterable listAll() { ... } Enunciate doesn’t seem to be able to…
Hawkeye Parker
  • 7,817
  • 7
  • 44
  • 47
0
votes
1 answer

How can I add jar/war dependencies to ant fileset while using gradle?

I have a gradle configuration which performs my compile and packaging of the war. I have an ant script that I want to invoke after the war enunciate.codehaus.org. The ant script needs access to the jars that were bundled into the war. Gradle…
jayraynet
  • 896
  • 1
  • 7
  • 24
0
votes
1 answer

Enunciate Example JSON shows Maps as Array

The Example JSON from the Enunciate docs module shows maps as an array of Objects. For instance, I have an object like: @JsonRootType @JsonName("MyObj") @XmlRootElement public class MyObject { @DocumentationExample("John Doe") private String…
Dave Thompson
  • 1
  • 1
0
votes
1 answer

Ennunciate Documentation for tweaking the output

I've found that ennuciate is good at documenting our JAXB REST webservice but there appears to be minimal documentation on how to tweak the output generated. Is there a definitive list of annotations that we can use to describe the parameters for…
Gordon Thompson
  • 4,764
  • 8
  • 48
  • 62
0
votes
2 answers

Integrate enunciate and ant for REST APIs document

I am encountering an error during integrating enunciate and ant for CXF REST service APIs project. Error exists in method getFeeItemsByCapID(). I try to find answer in source code, but without result. Who has any idea about the error? Thanks for…
Dylan
  • 179
  • 2
  • 12
0
votes
2 answers

Is there a work-around for enunciate regarding multidimensional arrays within an api class (docs maven goal)?

I'm hitting the error "No support yet for multidimensional arrays" when running docs goal for maven plugin enunciate. Is there a way I can avoid it bombing out the process (ie. generate the rest of the docs for the API)? I've tried…
Ben Rose
  • 43
  • 1
  • 10
0
votes
1 answer

Generating example xml/json for message body for lists, arrays, maps, etc. with enunciate?

I'm able to generate REST API documentation via enunciate and I really like the example xml and json it generates for the message bodies. I can't find how to get it to generate those for lists, arrays, maps, etc. though. I'm using maven, configured…
Ben Rose
  • 43
  • 1
  • 10
0
votes
1 answer

Using enunciate, how can I have all rest APIs linked from one page when running against a multi module pom?

I'm able to run mvn enunciate:docs against my multi-module pom where modules are complete implementations of services and the sites are created under each of those (ex. service1/rest/api/target/site/wsdocs/index.html) but I would like all the rest…
Ben Rose
  • 43
  • 1
  • 10
1 2 3
…
9
10