Question

到目前为止，我们正在成功使用Loopback，但我们希望在API文档中添加查询参数。

在我们的swagger.json文件中，我们可能看起来像=＆gt;

    {
      "swagger": "2.0",
      "info": {
        "version": "1.0.0",
        "title": "poc-discovery"
      },
      "basePath": "/api",
      "paths": {
        "/Users/{id}/accessTokens/{fk}": {
          "get": {
            "tags": [
              "User"
            ],
            "summary": "Find a related item by id for accessTokens.",
            "operationId": "User.prototype.__findById__accessTokens",
            "parameters": [
              {
                "name": "fk",
                "in": "path",
                "description": "Foreign key for accessTokens",
                "required": true,
                "type": "string",
                "format": "JSON"
              },
              {
                "name": "id",
                "in": "path",
                "description": "User id",
                "required": true,
                "type": "string",
                "format": "JSON"
              },
               {  
                  "name":"searchText",
                  "in":"query",
                  "description":"The Product that needs to be fetched",
                  "required":true,
                  "type":"string"
               },
               {  
                  "name":"ctrCode",
                  "in":"query",
                  "description":"The Product locale needs to be fetched. Example=en-GB, fr-FR, etc.",
                  "required":true,
                  "type":"string"
               },
            ],

我99％确定swagger.json信息是通过/server/models目录中的.json文件中的信息动态生成的。

我希望我可以在这些.json文件中添加我们接受的每个模型的查询参数。我想避免的是必须直接修改swagger.json。

添加查询参数的最佳方法是什么，以便它们显示在我们的文档中？关于如何最好地解决这个问题非常困惑。

Answer 1

经过几个小时的修补后，我担心没有直接的方法来实现这一点，因为此处生成的swagger规范表示模型方法的远程元数据以及来自{的模型数据{1}}档案。
因此，更新内置模型方法的远程处理元数据将具有挑战性，方法实现可能无法完全支持它。

正确的方法，IMO，这里是：
- 围绕内置方法创建一个remoteMethod包装器，您希望为其注入额外的参数以及model.json映射数据。 - 并且，使用禁用内置方法的REST端点 http。

在Loopback中为基本CRUD操作定义查询参数

1 个答案: