[jira] [Commented] (TIKA-1269) Self-hosted documentation for the JAX-RS Server

["Nick Burch (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/TIKA-1269?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13964762#comment-13964762 ] 

Nick Burch commented on TIKA-1269:
----------------------------------

Some CXF people at ApacheCon have suggested that Enunciate may be able to help with this, but given how few endpoints we have + that we want to generate + host things on the fly, it might not be the best fix. (Enunciate seems, from initial investigations, to be more aimed at generating the docs at build time)

> Self-hosted documentation for the JAX-RS Server
> -----------------------------------------------
>
>                 Key: TIKA-1269
>                 URL: https://issues.apache.org/jira/browse/TIKA-1269
>             Project: Tika
>          Issue Type: Improvement
>          Components: server
>    Affects Versions: 1.5
>            Reporter: Nick Burch
>             Fix For: 1.6
>
>
> Currently, if you fire up the JAX-RS Tika Server, and go to the root of the server in a web browser, you get an empty page back. You have to know to head over to https://wiki.apache.org/tika/TikaJAXRS find out what the available URLs are
> We should self-host some simple documentation on the server at the root of it, so that people can discover what it offers. Ideally, this should be largely auto-generated based on the endpoints, so that we don't risk missing things when we add new features
> This will also allow us to potentially offer a sample running version of the server for people to discover Tika with



--
This message was sent by Atlassian JIRA
(v6.2#6252)