Nuxeo ApiDoc Server
Switch branches/tags
release-10.3-I20180919_0126 release-10.2 release-10.2-I20180705_0132 release-10.2-I20180703_0125 release-10.2-I20180515_0125 release-10.1 release-9.10 release-9.10-HF20 release-9.10-HF19 release-9.10-HF18 release-9.10-HF17 release-9.10-HF16 release-9.10-HF15 release-9.10-HF14 release-9.10-HF13 release-9.10-HF12 release-9.10-HF11 release-9.10-HF10 release-9.10-HF09 release-9.10-HF08 release-9.10-HF07 release-9.10-HF06 release-9.10-HF05 release-9.10-HF04 release-9.10-HF03 release-9.10-HF02 release-9.10-HF01 release-9.3 release-9.2 release-9.1 release-8.10 release-8.10-HF37 release-8.10-HF36 release-8.10-HF35 release-8.10-HF34 release-8.10-HF33 release-8.10-HF32 release-8.10-HF31 release-8.10-HF30 release-8.10-HF29 release-8.10-HF28 release-8.10-HF27 release-8.10-HF26 release-8.10-HF25 release-8.10-HF24 release-8.10-HF23 release-8.10-HF22 release-8.10-HF21 release-8.10-HF20 release-8.10-HF19 release-8.10-HF18 release-8.10-HF17 release-8.10-HF16 release-8.10-HF15 release-8.10-HF14 release-8.10-HF13 release-8.10-HF12 release-8.10-HF11 release-8.10-HF10 release-8.10-HF09 release-8.10-HF08 release-8.10-HF07 release-8.10-HF06 release-8.10-HF05 release-8.10-HF04 release-8.10-HF03 release-8.10-HF02 release-8.10-HF01 release-8.3 release-8.2 release-8.1 release-7.10 release-7.10-HF46 release-7.10-HF45 release-7.10-HF44 release-7.10-HF43 release-7.10-HF42 release-7.10-HF41 release-7.10-HF40 release-7.10-HF39 release-7.10-HF38 release-7.10-HF37 release-7.10-HF36 release-7.10-HF35 release-7.10-HF34 release-7.10-HF33 release-7.10-HF33-I20171026_0823 release-7.10-HF32 release-7.10-HF31 release-7.10-HF30 release-7.10-HF29 release-7.10-HF28 release-7.10-HF27 release-7.10-HF26 release-7.10-HF25 release-7.10-HF24 release-7.10-HF23 release-7.10-HF22 release-7.10-HF21 release-7.10-HF20
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
nuxeo-apidoc-core NXP-23863: Remove uncessary dependency on commons-logging Sep 26, 2018
nuxeo-apidoc-repo NXP-23863: Convert log4j files to log4j2 Sep 26, 2018
nuxeo-apidoc-webengine NXP-25910: use NuxeoPrincipal Oct 9, 2018
pkg update package May 31, 2011
.gitignore NXP-23047: Use es test config Sep 22, 2017
ReadMe.md NXP-19497: Update README May 31, 2016
build.xml
pom.xml Post release 10.2 Jul 9, 2018

ReadMe.md

About nuxeo-apidoc-server

This modules provides an API to browse the Nuxeo distribution tree :

- BundleGroup (maven group or artificial grouping)
  - Bundle
    - Component
      - Service
      - Extension Points
      - Contributions

The Nuxeo Distribution can be :

  • live : in memory (meaning runtime introspection)
  • persisted : saved in Nuxeo Repository as a tree of Documents

In addition a DocumentationService is provided to be able to :

  • extract Documentation that is built-in Nuxeo Runtime descriptors
  • extract Documentation that may be embedded inside the jar
  • add some use documentation (How to, Code samples ...)

What it can be used for

  • browse you distribution and write some documentation
  • check that a given contribution is deployed
  • play with Nuxeo Runtime

Parameters

  • org.nuxeo.apidoc.site.mode: Enable the site mode with a more user friendly design
  • org.nuxeo.apidoc.hide.current.distribution: Hide current distribution from the distribution listing
  • org.nuxeo.apidoc.hide.seam.components: Hide Seam components introspection

Modules

This plugin is composed of 2 bundles :

  • nuxeo-apidoc-core : for the low level API
  • nuxeo-apidoc-webengine : for JAX-RS API and Webview