从大摇大摆的LoopBack4中隐藏某些API端点 [英] Hide certain API endpoints from swagger LoopBack4

问题描述

我的应用程序是由LoopBack4框架完成的.在此图片中，存在三个API.我只想使用登录API.所以我不想在这里看到/users API.在LoopBack2和LoopBack3中可以做到这一点，但是我该如何使用LoopBack4在此招摇中隐藏此用户API.

是否有任何代码级配置?

解决方案

LoopBack 4将隐藏任何具有 x-visibility:undocumented 的Open API Spec 3.0 OperationObject ./p>

这意味着在控制器功能的 operation 装饰器上，您可以编写以下内容:

  class UserController {@get('/users'，{'x-visibility': '无证',...})异步getUsers(){...}} 

My application is made by the LoopBack4 framework. In this picture there are three API's are present. I want to use only the login API. So I don't want to visible /users API here. In LoopBack2 and LoopBack3 can do this but how can I hide this Users API from this swagger using LoopBack4.

Any code level configurations?

解决方案

LoopBack 4 will hide any Open API Spec 3.0 OperationObject that has x-visibility: undocumented.

This means that on a controller functions' operation decorator, you can write the following:

class UserController {
  @get('/users', {
    'x-visibility': 'undocumented',
    ...
  })
  async getUsers() {...}
}

这篇关于从大摇大摆的LoopBack4中隐藏某些API端点的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！