Mô tả các tham số URI trong RAML

Question

Tôi đang khai báo một bản ghi API dịch vụ REST trong RAML. Ứng dụng web của tôi cung cấp thiết bị, có thể được liệt kê, thu được bằng id hoặc theo mã. Khi tôi muốn toàn bộ danh sách, tôi không chỉ định bất kỳ tham số URI nào, tuy nhiên, để có được một thiết bị cụ thể, tôi làm. Đó là trạng thái hiện tại:

/equipment: 
    get: 
     body: 
     application/json: 
     application/xml: 
    description: 
     List all the equipment 
    /id/{equipmentId}: 
     get: 
     body: 
      application/json: 
      application/xml: 
     description: 
     Get an equipment by id 
    /code/{code}: 
     get: 
      body: 
      application/json: 
      application/xml: 
     description: 
       Get an equipment by code 

Ở đây, trong trường description Tôi viết những gì cuộc gọi hiện tại thực hiện. Tuy nhiên, tôi muốn thêm mô tả cho tham số được truyền trong chính URI (id hoặc code). Có cách nào để đạt được nó?

Answer 1

Bạn đang thiếu các phần uriParameters để mô tả các thông số equipmentId và code. Trong phần này, bạn có thể chỉ định thông thường: type, description ...

Xem phần URI Template và URI thông số trong spec: https://github.com/raml-org/raml-spec/blob/master/versions/raml-08/raml-08.md#template-uris-and-uri-parameters