Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

Document IDL process for development

Description

Intent of this story is to document the process that developers should follow when adding/augmenting web services (i.e. write IDL, write code/tests, and an [automated] step to produce the doc from the IDL)

Acceptance:

  • add RAML and tests to sample repository

  • Must have testing tech determined (e.g. use of Wiremock, RestAssured, etc.)

  • document the preferred flow of "Interface/IDL First", the general flow developers should follow when adding new interface methods

QAlity Plus - Test Management

Checklists

Activity

Show:

Ben Leibert July 5, 2016 at 5:59 AM
Edited

Addressed by commit 0777b19.

Because the “preferred flow” we wish to adopt with Soldevelo may not match the process that other teams wish to use, I didn’t describe it in our project’s ReadMe. Rather I’ll do so here:

As described in the example repository’s ReadMe, we describe our API using RAML. We also offer a preferred approach for integration-testing the API, generating user-friendly documentation for it, and ensuring that it’s congruous with the specification defined within the project’s RAML.

Generally, desired modifications to our API will be described via the project’s RAML file. These specification changes will often be made by VillageReach. Based on them, a partner will know what API related functionality to implement. Optionally, this partner will take a test-driven approach, wherein they’ll write code like that within the sample repository’s BookIntegrationTest.java file prior to creating or augmenting a Spring MVC controller.

Done
Pinned fields
Click on the next to a field label to start pinning.

Details

Assignee

Reporter

Story Points

Sprint

Fix versions

Affects versions

Priority

Parent

Time Assistant

Created June 29, 2016 at 6:44 PM
Updated November 12, 2016 at 11:36 AM
Resolved July 5, 2016 at 6:04 AM