[CIRC-149] Provide a Development Guide - FOLIO Issue Tracker

XML

Word

Printable

Details

Type: Task
Status: Closed (View Workflow)
Priority: P3
Resolution: Won't Do
Affects Version/s: None
Fix Version/s: None
Labels:
- back-end
- documentation

Template:
Development Team:
Vega
Epic Link:
Loans

Description

In order to help developers become familiar with mod-circulation, it could be useful to provide a development guide

Proposed Contents

API structure
Module design approach
- Chaining futures
- Using results to guide flow
Code layout
- Resources
- Domain
- Repositories, finders etc
- Support
Automated testing
Approach
- API testing
- Integration points
Initialisation
- Test suite
- API tests base class
Builders and fixtures
- RestAssurred
Fake Okapi and storage modules
Hamcrest matchers
Running the tests
- Using fakes
- Using Okapi and modules

TestRail: Results

Attachments

Activity

People

Assignee:: Unassigned

Reporter:: Marc Johnson

Votes:: 0 Vote for this issue

Watchers:: 2 Start watching this issue

Dates

Created:: 23/Oct/18 1:35 PM

Updated:: 04/May/22 12:42 PM

Resolved:: 04/May/22 12:42 PM

TestRail: Runs

TestRail: Cases