makeomatic / makeomatic/restify-formatter-jsonapi

how to use?

未关闭
#2 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
JavaScript
星标
1
派生
1
PR 合并指标
30 天内没有已合并 PR

描述

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.

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 issue #2 中的使用问题开始,比较文档中介绍的 restify-formatter-jsonapi 导入、server.userestify.acceptParsercreateServer({ formatters }) 入口点。完成的标准是记录正确的设置方式以及格式化后的 JSON 暴露在哪里,并提供一个可运行的示例或验证路径。

由索引模型根据 Issue 内容生成。

评估

技术栈
javascript
领域
documentation
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。