Uploaded image for project: 'mod-kb-ebsco-java'
  1. mod-kb-ebsco-java
  2. MODKBEKBJ-46

SPIKE: PoC - integrate springmvc-raml-plugin into the sample spring application

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Closed (View Workflow)
    • Priority: P3
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
      None
    • Template:
    • Sprint:
      eHoldings Sprint 49
    • Story Points:
      8

      Description

      Need to check if we can use the maven plugin https://github.com/phoenixnap/springmvc-raml-plugin to generate Spring MVC Controllers and DTOs for FOLIO RAMLs

      Initial requirements for the plugin

      • for endpoints it has to generate interfaces or classes that could be extended to implement the necessary logic [MUST];
      • support !include directive in RAML files like below :
      types:
        note: !include note.json
        noteCollection: !include noteCollection.json
        errors: !include raml-util/schemas/errors.schema
      
      • support definition of a single element in collection as $ref like below:
      {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Rules Collection",
        "type": "object",
        "properties": {
          "rules": {
            "description": "List of rules",
            "type": "array",
            "id": "ruleList",
            "items": {
              "type": "object",
              "$ref": "rule.json"
            }
          },
          "totalRecords": {
            "type": "integer"
          }
        },
        "required": [
          "rules",
          "totalRecords"
        ]
      }
      

      Expected outcomes

      • POC project to prove the plugin supports the specified requirements
        • in case some of the requirement is not supported identify possible options to achieve one
      • a wiki page which describes what was done and what was achieved (POC description, issues found, TODOs etc)

        TestRail: Results

          Attachments

            Issue Links

              Activity

                People

                Assignee:
                kgambrell Khalilah Gambrell
                Reporter:
                Taras_Spashchenko Taras Spashchenko
                Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                  Dates

                  Created:
                  Updated:
                  Resolved:

                    TestRail: Runs

                      TestRail: Cases