search

alavrik / piqi

Piqi – universal schema language: JSON, XML, Protocol Buffers data validation and conversion
http://piqi.org
Apache License 2.0
246 stars 36 forks source link

piqidoc #27

Open edmcman opened 11 years ago

edmcman commented 11 years ago

It would be great to have a piqidoc tool that generates some pretty HTML pages documenting a type.

As I see it, piqi is a way to publicly specify and document a type. Values of that type can be converted to many formats, and "parsed" by JSON/XML in almost any language. Being able to generate a pretty representation of the types and documentation for humans seems like the final step.

alavrik commented 11 years ago

Yes, this is already on the project roadmap. What would be even cooler is the ability to generate cross-linked HTML pages and publish them online.

motiejus commented 11 years ago

You could take into account that XSD generation would be very useful to have as well (sometime in far future I guess). It is a separate task, but looks on the same page. :-)