Hello François, Thanks for clarifying that I wasn't aware that you could use Swagger that way. That makes sense.
For GraphQL yes the final version of the CXS specification I'm also co-developing has switched from REST to GraphQL, and I'm currently implementing that in a branch to validate the design of the GraphQL schema. It's a challenge because we are doing some advanced stuff with GraphQL but the API is already a lot more powerful than the REST API. cheers, Serge... On Tue, Jul 31, 2018 at 6:25 PM Francois Papon <[email protected]> wrote: > > Hi Serge, > > Thanks for your feedback :) > > I see the Miredot documentation and for me it's good. > > I propose to add Swagger (not to replace Miredot) to have a GUI to > simulate request and response for developers. > > I already used the cxf-swagger-feature in a Karaf project and the only > bug I found it's the refresh of the json when updating the bundle in a > started instance. > > I have in mind to propose a page on the website dedicated to the API > like this : > > https://projects.tmforum.org/wiki/display/API/Open+API+Table > > I saw a JIRA about GraphQL integration, it's great :) > > regards, > > François Papon > [email protected] > > Le 31/07/2018 à 19:48, Serge Huber a écrit : > > Hello François, > > > > Thank you for your proposal, I really like the new design ! > > > > For me, the user documentation could be reformated to make it easier > > to browse and of course, it always needs improving and detailing. > > > > Concerning the REST API documentation, currently, we use another tool > > to generate it from the source code, and it is capable of documenting > > the JSON structure at the same time. The whole source code was > > documented to work with this plugin (http://www.miredot.com/) for > > which we got a free license since it is an Apache project. Are you > > suggesting we replace this with Swagger (we evaluated it at the time > > but it was missing some features for generating from the code) ? > > > > Regards, > > Serge... > > On Tue, Jul 31, 2018 at 2:42 PM Francois Papon > > <[email protected]> wrote: > >> Hi, > >> > >> I'm new with the Apache Unomi project and I would like to make some > >> proposals around the website and the documentation :) > >> > >> *1 - Website :* > >> > >> Actually, the website is auto generate and link to the project release > >> livecycle, however we could made some changes any time, like posting > >> news, uses cases... > >> > >> That's why I think the website can have he's dedicated repository and > >> could be only build on html static pages. > >> > >> I started a WIP with the home page and you can have a preview here : > >> https://openobject.fr/unomi > >> > >> *2 - User guide :* > >> > >> The user guide is good and could be link to the release, may be to major > >> release ? > >> > >> We have the documentation in md format for Github and html for the > >> website, we also could have a pdf from the html. > >> > >> *3 - API Rest documentation :* > >> > >> May be we could provided an instance of Swagger from the website for > >> developers, it's convenient for have some request/response (their is an > >> existing cxf-swagger feature for generating the json). > >> > >> > >> If you are interesting, I can help on this items :) > >> > >> regards, > >> > >> -- > >> François Papon > >> [email protected] > >> >
