Uploaded image for project: 'Smart Campus'
  1. Smart Campus
  2. SCCI-55

Describing and documenting interfaces to core services

    XMLWordPrintableJSON

    Details

    • Type: Epic
    • Status: To Do
    • Priority: Normal
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Back End Services
    • Labels:
      None
    • Epic Name:
      Core Services Design

      Description

      As a software architect, I need to clearly describe and document the interfaces to the core services, so that they can be shared with other developers and used while developing these services in parallel.

      Let's follow the OpenAPI Spec 3 (https://swagger.io/specification/) when describing the services. 

      Some examples for reference:

      https://opensource.ncsa.illinois.edu/confluence/display/BD/Brown+Dog+API

      https://bd-api.ncsa.illinois.edu/docs/

        Gliffy Diagrams

          Attachments

            Activity

              People

              Assignee:
              sandeeps Sandeep Puthanveetil Satheesan
              Reporter:
              sandeeps Sandeep Puthanveetil Satheesan
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:

                  Tasks