Uploaded image for project: 'SiteWhere'
  1. SITEWHERE-207

Create generator for static REST services documentation

    Details

    • Type: New Feature
    • Status: Resolved
    • Priority: Major
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: 1.2.0
    • Component/s: Documentation
    • Labels:
      None

      Description

      After testing a number of generators for static REST services documentation, none satisfied all of our needs. Create a custom documentation generator that uses annotation data along with markdown and JSON examples to create a complete end-to-end REST services guide. The documentation should be generated automatically as part of the build. JSON examples should be derived from the SiteWhere object model and use marshaling already used elsewhere in the system so output is always valid as changes are made.

        Attachments

          Activity

            People

            • Assignee:
              dadams Derek Adams [Administrator]
              Reporter:
              dadams Derek Adams [Administrator]
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: