easysoa / EasySOA

A light, collaborative platform to make Service Oriented Architecture simple.
http://www.easysoa.org
35 stars 8 forks source link

Manual & generated service doc à la Nuxeo Bundle Explorer (apidoc server) #110

Open mdutoo opened 12 years ago

mdutoo commented 12 years ago

At least take inspiration from its principles, which are

concepts : Distribution, BundleGroup, Bundle, Component (= atomic impl, builtInDocumentation, isXml, services as stringList), ExtensionPoint (confble engine), Contribution (=conf, refers to extensionPoint by String), Service, SeamComponent, Operation (params as ComplexType, signature as stringList), Documentation (target = artifact ref, applicableVersions, nuxeoApproved, type, renderingType, id) voir https://github.com/nuxeo/nuxeo-apidoc-server/tree/master/nuxeo-apidoc-core/src/main/resources/schemas et https://github.com/nuxeo/nuxeo-apidoc-server/blob/master/nuxeo-apidoc-core/src/main/resources/OSGI-INF/doctype-contrib.xml

infos basées sur de l'introspection des bundles du runtime en exécution : reads OSGI manifest, see https://github.com/nuxeo/nuxeo-apidoc-server/blob/master/nuxeo-apidoc-core/src/main/java/org/nuxeo/apidoc/introspection/ServerInfo.java supports snapshot updates (?)

ui : webengine jaxrs, see https://github.com/nuxeo/nuxeo-apidoc-server/tree/master/nuxeo-apidoc-webengine/src/main/java/org/nuxeo/apidoc/browse dont virtualNode https://github.com/nuxeo/nuxeo-apidoc-server/blob/master/nuxeo-apidoc-webengine/src/main/java/org/nuxeo/apidoc/tree/VirtualNode.java cache & auth filter https://github.com/nuxeo/nuxeo-apidoc-server/blob/master/nuxeo-apidoc-webengine/src/main/java/org/nuxeo/apidoc/filter/CacheAndAuthFilter.java