node.js - 我可以为 REST api 中的不同方法编写相同的路径名吗？

Question

我正在使用 Swagger api 编写 REST API 。现在，我想按以下方式编写插入、更新和删除方法(我在网上的许多 API 上都看到过这样的路径):

1. POST(用于插入)

/学生

PUT(用于更新)

/学生/{studentId}

DELETE(用于删除)

/学生/{studentId}

现在，1 没问题，但 2 和 3 是相同的路径(但有不同的方法)。当我这样写时，Swagger API 给了我错误。那么这真的不允许吗？

如果不允许，有哪些最佳方法可以定义不同的路径而不使它们很长并且仍然看起来“很酷”？

Answer 1

要为同一路径定义不同的方法(GET/PUT/DELETE/等)，只需在该路径下列出这些方法，如下所示:

paths:
  /students/{studentId}:
    # Common parameter for all methods on this path
    parameters:
      - name: studentId
        in: path
        ...

    get:
      summary: Get a student by ID
      ...

    put:
      summary: Update a student
      ...

    delete:
      summary: Delete a student
      ...