how to use?

Open
#2 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
javascript
Domain
documentation

Research direction

Start with the usage question in issue #2 and compare the documented restify-formatter-jsonapi import, server.use, restify.acceptParser, and createServer({ formatters }) entry points. Done means documenting the correct setup and where the formatted JSON is exposed, with a working example or verification path.

Written by the indexing model from the issue text.

Description

Hi,
Can you please clarify what "Make sure to add this into accepts middleware" means exactly? I import it as:

jsonapi_formatter = require('restify-formatter-jsonapi');

So do you mean to do this?

server.use(restify.acceptParser(jsonapi_formatter));

Currently I'm trying:

const server = restify.createServer({
  formatters: jsonapi_formatter
}

but that doesn't seem to be working, or at least if it is I can't find the formatted JSON in the request object anywhere. Can you please clarify how this is supposed to be used exactly? Would be super grateful.

Dominant language
JavaScript
Stars
1
Forks
1
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.