Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Improve documentation #54

Copy link
Copy link
@thill-odi

Description

@thill-odi
Issue body actions

The existing documentation is good as far as it goes, but leaves out a lot of context. To illustrate more fully how the library is to be used, we need to make clear that the library is essentially used to create a (very simple) API.

This means we need to lay out a straightforward sequence for developers walking them through from receiving the request to returning the response. We thus need steps, with examples, illustrating:

  1. Receiving a request
  2. Parsing the request for parameters
  3. Querying the database
  4. Using the query results to create data items
  5. Sequencing these data items
  6. Wrapping up these data items as an RPDE feed
  7. Serialising the RPDE feed to JSON
  8. Returning this JSON as a response
Reactions are currently unavailable

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    Morty Proxy This is a proxified and sanitized view of the page, visit original site.