我在哪里可以找到/修改Loopbackjs模型元数据?

时间:2014-10-08 14:20:09

标签: swagger loopbackjs api-doc

正如您现在所做的那样,Loopbackjs框架会显示一个基于swagger的explorer interface公开您的API端点并简要解释这些方法。这个问题就是这个界面有点过于交互。

我需要为我的API提供api-docs(ish)文档,我目前在/ common / models js文件中添加@annotations ,但我怀疑我&#39 ;在这里重新发明轮子。对于swagger-ui / loopback-explorer来显示其界面,端点必须已经暴露了某种元数据,对吧?

我希望通过说明,示例,自定义状态代码完成它并且不需要"尝试它"纽扣。看到这个的用户不会非常欣赏这么多的互动。

1 个答案:

答案 0 :(得分:2)

您可以访问" swagger"对于你的LoopBack模型,点击" raw" LoopBack Explorer中任何模型最右侧的按钮,您将看到描述模型的swagger JSON。

如果您确实想要自定义API资源管理器界面,请查看以下文章:

http://www.podstud.io/blog/angular-swagger-jacking/

然后您可以访问Model Swagger Resources并提供您想要的任何类型的光滑界面......

希望这能让你朝着正确的方向前进......