работать как получить и разместить в чванство - PullRequest
0 голосов
/ 29 марта 2020

Я пишу документацию для разных API. API проходят через разные микро сервисы. API использует метод get для одного микросервиса и post для другого микросервиса. Я немного запутался, как собираюсь делать документацию для него. Например, это мой API:

app.get('/uploadimage', isLoggedIn, async(req, res) => {
  // console.log(res.locals.newToken);
  const decoded = jwt.decode(res.locals.newToken);
  console.log(decoded);
  req.body.profileID = decoded.profileID
  try {
    const response = await transport.post(posty.API2 + '/uploadimage/', req.body);
    console.log(response.data);
    return res.status(200).send(apiResponse.sendReply(1, 'status fetched', {
      status: response.data.data
    }));

  } catch (err) {
    console.log(err.response.data);
  }
});

"/uploadimage": {
  "get": {
    "tags": [
      "Profiler"
    ],
    "summary": "Upload Image",
    "description": "Upload Image",
    "operationId": "uploadimage",
    "produces": [
      "application/json"
    ],
    "parameters": [{
      "name": "profileID",
      "in": "path",
      "description": "Upload Image",
      "required": true,
      "type": "string"
    }],
    "responses": {
      "200": {
        "description": "Success",
        "schema": {
          "type": "object",
          "properties": {
            "profileID": {
              "type": "string"
            }
          }
        }
      },
      "400": {
        "description": "Invalid profileID supplied"
      }
    }
  }
}
...